Module: XbimAim

Defined in:
lib/xbim_aim/version.rb,
lib/xbim_aim.rb,
lib/xbim_aim/api_error.rb,
lib/xbim_aim/api_client.rb,
lib/xbim_aim/models/job.rb,
lib/xbim_aim/models/row.rb,
lib/xbim_aim/models/cell.rb,
lib/xbim_aim/models/role.rb,
lib/xbim_aim/models/site.rb,
lib/xbim_aim/models/zone.rb,
lib/xbim_aim/api/jobs_api.rb,
lib/xbim_aim/api/logs_api.rb,
lib/xbim_aim/models/asset.rb,
lib/xbim_aim/models/issue.rb,
lib/xbim_aim/models/level.rb,
lib/xbim_aim/models/model.rb,
lib/xbim_aim/models/space.rb,
lib/xbim_aim/models/spare.rb,
lib/xbim_aim/api/admin_api.rb,
lib/xbim_aim/api/sites_api.rb,
lib/xbim_aim/api/stats_api.rb,
lib/xbim_aim/api/zones_api.rb,
lib/xbim_aim/configuration.rb,
lib/xbim_aim/models/entity.rb,
lib/xbim_aim/api/assets_api.rb,
lib/xbim_aim/api/issues_api.rb,
lib/xbim_aim/api/levels_api.rb,
lib/xbim_aim/api/models_api.rb,
lib/xbim_aim/api/spaces_api.rb,
lib/xbim_aim/api/spares_api.rb,
lib/xbim_aim/api/wexbim_api.rb,
lib/xbim_aim/models/contact.rb,
lib/xbim_aim/api/systems_api.rb,
lib/xbim_aim/models/document.rb,
lib/xbim_aim/models/facility.rb,
lib/xbim_aim/models/ifc_type.rb,
lib/xbim_aim/models/job_edit.rb,
lib/xbim_aim/models/job_info.rb,
lib/xbim_aim/models/resource.rb,
lib/xbim_aim/models/schedule.rb,
lib/xbim_aim/api/contacts_api.rb,
lib/xbim_aim/api/entities_api.rb,
lib/xbim_aim/models/component.rb,
lib/xbim_aim/models/db_update.rb,
lib/xbim_aim/models/footprint.rb,
lib/xbim_aim/models/zone_info.rb,
lib/xbim_aim/api/documents_api.rb,
lib/xbim_aim/api/resources_api.rb,
lib/xbim_aim/api/schedules_api.rb,
lib/xbim_aim/models/asset_edit.rb,
lib/xbim_aim/models/entity_ref.rb,
lib/xbim_aim/models/issue_info.rb,
lib/xbim_aim/models/job_create.rb,
lib/xbim_aim/models/level_edit.rb,
lib/xbim_aim/models/level_info.rb,
lib/xbim_aim/models/model_edit.rb,
lib/xbim_aim/models/model_info.rb,
lib/xbim_aim/models/space_edit.rb,
lib/xbim_aim/models/space_info.rb,
lib/xbim_aim/models/spare_edit.rb,
lib/xbim_aim/models/spare_info.rb,
lib/xbim_aim/api/assemblies_api.rb,
lib/xbim_aim/api/attributes_api.rb,
lib/xbim_aim/api/components_api.rb,
lib/xbim_aim/api/facilities_api.rb,
lib/xbim_aim/api/thumbnails_api.rb,
lib/xbim_aim/models/application.rb,
lib/xbim_aim/models/entity_base.rb,
lib/xbim_aim/models/entity_edit.rb,
lib/xbim_aim/models/member_role.rb,
lib/xbim_aim/models/role_member.rb,
lib/xbim_aim/models/system_info.rb,
lib/xbim_aim/models/system_item.rb,
lib/xbim_aim/api/diagnostics_api.rb,
lib/xbim_aim/api/model_files_api.rb,
lib/xbim_aim/models/asset_create.rb,
lib/xbim_aim/models/contact_info.rb,
lib/xbim_aim/models/level_create.rb,
lib/xbim_aim/models/model_create.rb,
lib/xbim_aim/models/quota_status.rb,
lib/xbim_aim/models/space_create.rb,
lib/xbim_aim/models/spare_create.rb,
lib/xbim_aim/api/applications_api.rb,
lib/xbim_aim/models/assembly_info.rb,
lib/xbim_aim/models/assembly_item.rb,
lib/xbim_aim/models/asset_segment.rb,
lib/xbim_aim/models/document_edit.rb,
lib/xbim_aim/models/document_info.rb,
lib/xbim_aim/models/entity_create.rb,
lib/xbim_aim/models/facility_info.rb,
lib/xbim_aim/models/inline_object.rb,
lib/xbim_aim/models/model_mapping.rb,
lib/xbim_aim/models/resource_info.rb,
lib/xbim_aim/api/model_mapping_api.rb,
lib/xbim_aim/models/component_edit.rb,
lib/xbim_aim/models/component_info.rb,
lib/xbim_aim/models/component_type.rb,
lib/xbim_aim/models/contact_entity.rb,
lib/xbim_aim/models/entity_contact.rb,
lib/xbim_aim/models/inline_object1.rb,
lib/xbim_aim/models/inline_object2.rb,
lib/xbim_aim/models/inline_object3.rb,
lib/xbim_aim/models/inline_object4.rb,
lib/xbim_aim/models/inline_object5.rb,
lib/xbim_aim/models/related_entity.rb,
lib/xbim_aim/api/document_files_api.rb,
lib/xbim_aim/models/attribute_value.rb,
lib/xbim_aim/models/document_create.rb,
lib/xbim_aim/models/value_container.rb,
lib/xbim_aim/api/component_types_api.rb,
lib/xbim_aim/models/component_create.rb,
lib/xbim_aim/models/user_permissions.rb,
lib/xbim_aim/models/column_definition.rb,
lib/xbim_aim/models/entity_match_info.rb,
lib/xbim_aim/models/member_permission.rb,
lib/xbim_aim/models/complex_value_base.rb,
lib/xbim_aim/models/file_upload_result.rb,
lib/xbim_aim/models/i_metered_resource.rb,
lib/xbim_aim/models/mapping_properties.rb,
lib/xbim_aim/models/classification_node.rb,
lib/xbim_aim/models/component_type_info.rb,
lib/xbim_aim/models/entity_mapping_info.rb,
lib/xbim_aim/models/assembly_diagnostics.rb,
lib/xbim_aim/models/attribute_definition.rb,
lib/xbim_aim/models/mapping_message_info.rb,
lib/xbim_aim/models/model_mapping_report.rb,
lib/xbim_aim/models/attribute_value_entity.rb,
lib/xbim_aim/models/entity_match_descriptor.rb,
lib/xbim_aim/models/attribute_definition_edit.rb,
lib/xbim_aim/models/o_data_response_of_boolean.rb,
lib/xbim_aim/models/attribute_definition_create.rb,
lib/xbim_aim/models/attribute_definition_entity.rb,
lib/xbim_aim/models/o_data_list_response_of_job.rb,
lib/xbim_aim/models/o_data_list_response_of_row.rb,
lib/xbim_aim/models/o_data_list_response_of_role.rb,
lib/xbim_aim/models/o_data_list_response_of_site.rb,
lib/xbim_aim/models/o_data_list_response_of_zone.rb,
lib/xbim_aim/models/o_data_list_response_of_asset.rb,
lib/xbim_aim/models/o_data_list_response_of_issue.rb,
lib/xbim_aim/models/o_data_list_response_of_level.rb,
lib/xbim_aim/models/o_data_list_response_of_model.rb,
lib/xbim_aim/models/o_data_list_response_of_space.rb,
lib/xbim_aim/models/o_data_list_response_of_spare.rb,
lib/xbim_aim/models/o_data_list_response_of_entity.rb,
lib/xbim_aim/models/o_data_list_response_of_contact.rb,
lib/xbim_aim/models/o_data_list_response_of_document.rb,
lib/xbim_aim/models/o_data_list_response_of_facility.rb,
lib/xbim_aim/models/o_data_list_response_of_resource.rb,
lib/xbim_aim/models/o_data_list_response_of_schedule.rb,
lib/xbim_aim/models/o_data_list_response_of_component.rb,
lib/xbim_aim/models/o_data_list_response_of_entity_ref.rb,
lib/xbim_aim/models/o_data_list_response_of_application.rb,
lib/xbim_aim/models/o_data_list_response_of_system_item.rb,
lib/xbim_aim/models/o_data_list_response_of_assembly_item.rb,
lib/xbim_aim/models/o_data_list_response_of_model_mapping.rb,
lib/xbim_aim/models/o_data_list_response_of_component_type.rb,
lib/xbim_aim/models/o_data_list_response_of_attribute_value.rb,
lib/xbim_aim/models/o_data_list_response_of_member_permission.rb,
lib/xbim_aim/models/o_data_list_response_of_complex_value_base.rb,
lib/xbim_aim/models/o_data_list_response_of_assembly_diagnostics.rb,
lib/xbim_aim/models/o_data_list_response_of_attribute_definition.rb,
lib/xbim_aim/models/o_data_list_response_of_model_mapping_report.rb,
lib/xbim_aim/models/o_data_list_response_of_attribute_definition_entity.rb

Overview

#XBIM Flex API v2

#This is the XBIM Flex Swagger service where you can explore the REST API for the platform.

The version of the OpenAPI document: 2.0 Contact: [email protected] Generated by: openapi-generator.tech OpenAPI Generator version: 5.4.0

Defined Under Namespace

Classes: AdminApi, ApiClient, ApiError, Application, ApplicationsApi, AssembliesApi, AssemblyDiagnostics, AssemblyInfo, AssemblyItem, Asset, AssetCreate, AssetEdit, AssetSegment, AssetsApi, AttributeDefinition, AttributeDefinitionCreate, AttributeDefinitionEdit, AttributeDefinitionEntity, AttributeValue, AttributeValueEntity, AttributesApi, Cell, ClassificationNode, ColumnDefinition, ComplexValueBase, Component, ComponentCreate, ComponentEdit, ComponentInfo, ComponentType, ComponentTypeInfo, ComponentTypesApi, ComponentsApi, Configuration, Contact, ContactEntity, ContactInfo, ContactsApi, DbUpdate, DiagnosticsApi, Document, DocumentCreate, DocumentEdit, DocumentFilesApi, DocumentInfo, DocumentsApi, EntitiesApi, Entity, EntityBase, EntityContact, EntityCreate, EntityEdit, EntityMappingInfo, EntityMatchDescriptor, EntityMatchInfo, EntityRef, FacilitiesApi, Facility, FacilityInfo, FileUploadResult, Footprint, IMeteredResource, IfcType, InlineObject, InlineObject1, InlineObject2, InlineObject3, InlineObject4, InlineObject5, Issue, IssueInfo, IssuesApi, Job, JobCreate, JobEdit, JobInfo, JobsApi, Level, LevelCreate, LevelEdit, LevelInfo, LevelsApi, LogsApi, MappingMessageInfo, MappingProperties, MemberPermission, MemberRole, Model, ModelCreate, ModelEdit, ModelFilesApi, ModelInfo, ModelMapping, ModelMappingApi, ModelMappingReport, ModelsApi, ODataListResponseOfApplication, ODataListResponseOfAssemblyDiagnostics, ODataListResponseOfAssemblyItem, ODataListResponseOfAsset, ODataListResponseOfAttributeDefinition, ODataListResponseOfAttributeDefinitionEntity, ODataListResponseOfAttributeValue, ODataListResponseOfComplexValueBase, ODataListResponseOfComponent, ODataListResponseOfComponentType, ODataListResponseOfContact, ODataListResponseOfDocument, ODataListResponseOfEntity, ODataListResponseOfEntityRef, ODataListResponseOfFacility, ODataListResponseOfIssue, ODataListResponseOfJob, ODataListResponseOfLevel, ODataListResponseOfMemberPermission, ODataListResponseOfModel, ODataListResponseOfModelMapping, ODataListResponseOfModelMappingReport, ODataListResponseOfResource, ODataListResponseOfRole, ODataListResponseOfRow, ODataListResponseOfSchedule, ODataListResponseOfSite, ODataListResponseOfSpace, ODataListResponseOfSpare, ODataListResponseOfSystemItem, ODataListResponseOfZone, ODataResponseOfBoolean, QuotaStatus, RelatedEntity, Resource, ResourceInfo, ResourcesApi, Role, RoleMember, Row, Schedule, SchedulesApi, Site, SitesApi, Space, SpaceCreate, SpaceEdit, SpaceInfo, SpacesApi, Spare, SpareCreate, SpareEdit, SpareInfo, SparesApi, StatsApi, SystemInfo, SystemItem, SystemsApi, ThumbnailsApi, UserPermissions, ValueContainer, WexbimApi, Zone, ZoneInfo, ZonesApi

Constant Summary collapse

VERSION = 
'2.0.1'

Class Method Summary collapse

Class Method Details

.configure ⇒ Object

Customize default settings for the SDK using block.

XbimAim.configure do |config|
  config.username = "xxx"
  config.password = "xxx"
end

If no block given, return the default Configuration object.



189
190
191
192
193
194
195
 
# File 'lib/xbim_aim.rb', line 189

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end