xbim_aim
XbimAim - the Ruby gem for the XBIM Flex API v2
This is the XBIM Flex Swagger service where you can explore the REST API for the platform.
This SDK is automatically generated by the OpenAPI Generator project:
- API version: 2.0
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.RubyClientCodegen For more information, please visit https://xbim.net
Installation
Build a gem
To build the Ruby code into a gem:
gem build xbim_aim.gemspec
Then either install the gem locally:
gem install ./xbim_aim-1.0.0.gem
(for development, run gem install --dev ./xbim_aim-1.0.0.gem
to install the development dependencies)
or publish the gem to a gem hosting service, e.g. RubyGems.
Finally add this to the Gemfile:
gem 'xbim_aim', '~> 1.0.0'
Install from Git
If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
gem 'xbim_aim', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
Include the Ruby code directly
Include the Ruby code directly using -I
as follows:
ruby -Ilib script.rb
Getting Started
Please follow the installation procedure and then run the following code:
# Load the gem
require 'xbim_aim'
# Setup authorization
XbimAim.configure do |config|
# Configure OAuth2 access token for authorization: oauth2
config.access_token = 'YOUR ACCESS TOKEN'
end
api_instance = XbimAim::AdminApi.new
region = 'UK' # String | The data center region the data resides in
begin
#Lists the Database schema updates already installed
result = api_instance.admin_applied_updates(region)
p result
rescue XbimAim::ApiError => e
puts "Exception when calling AdminApi->admin_applied_updates: #{e}"
end
Documentation for API Endpoints
All URIs are relative to https://apis.xbim-dev.net
Class | Method | HTTP request | Description |
---|---|---|---|
XbimAim::AdminApi | admin_applied_updates | GET /region/aim/2.0/admin/schema/AppliedUpdates | Lists the Database schema updates already installed |
XbimAim::AdminApi | admin_flush_caches | POST /region/aim/2.0/admin/schema/FlushCaches | Flushes the Flex caches |
XbimAim::AdminApi | admin_get_is_current | GET /region/aim/2.0/admin/schema/IsCurrent | Returns a flag indicating if the database schema requires an upgrade |
XbimAim::AdminApi | admin_pending_updates | GET /region/aim/2.0/admin/schema/PendingUpdates | Lists the Database schema updates required |
XbimAim::AdminApi | admin_update_schema | POST /region/aim/2.0/admin/schema/UpdateSchema | Updates the Database schemas to the latest version |
XbimAim::ApplicationsApi | applications_get_by_tenantid | GET /region/aim/2.0/tenantId/Applications | Returns the EntitySet Applications |
XbimAim::ApplicationsApi | applications_get_single_by_applicationid_and_tenantid | GET /region/aim/2.0/tenantId/Applications(ApplicationId) | Returns the entity with the key from Applications |
XbimAim::AssembliesApi | assemblies_add_document_by_assetmodelid_and_entityid_and_tenantid | POST /region/aim/2.0/tenantId/Assemblies(AssetModelId=assetModelId, EntityId=entityId)/DocumentEntities | Adds a new document to a model entity |
XbimAim::AssembliesApi | assemblies_as_of_by_date_and_tenantid | GET /region/aim/2.0/tenantId/Assemblies/AsOf(date=date) | Get Assemblies as of by date and tenantid |
XbimAim::AssembliesApi | assemblies_get_available_properties_by_assetid_and_tenantid | GET /region/aim/2.0/tenantId/Assemblies/GetAvailableProperties(assetId=assetId) | Gets the Properties available on this Model |
XbimAim::AssembliesApi | assemblies_get_by_tenantid | GET /region/aim/2.0/tenantId/Assemblies | Returns the EntitySet Assemblies |
XbimAim::AssembliesApi | assemblies_get_single_entity_by_assetmodelid_and_entityid_and_tenantid | GET /region/aim/2.0/tenantId/Assemblies(AssetModelId=assetModelId, EntityId=entityId) | Get Assemblies single entity by assetmodelid, entityid and tenantid |
XbimAim::AssembliesApi | assemblies_patch_by_assetmodelid_and_entityid_and_tenantid | PATCH /region/aim/2.0/tenantId/Assemblies(AssetModelId=AssetModelId, EntityId=EntityId) | Patch Assemblies by assetmodelid, entityid and tenantid |
XbimAim::AssembliesApi | assemblies_post_by_tenantid | POST /region/aim/2.0/tenantId/Assemblies | Post a new entity to EntitySet Assemblies |
XbimAim::AssetsApi | assets_assign_by_tenantid_and_assetid | POST /region/aim/2.0/tenantId/Assets(AssetId)/Roles.Assign | Assigns a user to the given role on the asset |
XbimAim::AssetsApi | assets_delete_by_assetid_and_tenantid | DELETE /region/aim/2.0/tenantId/Assets(AssetId) | Archive an Asset and and models for future deletion |
XbimAim::AssetsApi | assets_get_by_tenantid | GET /region/aim/2.0/tenantId/Assets | Returns the EntitySet Assets |
XbimAim::AssetsApi | assets_get_single_by_assetid_and_tenantid | GET /region/aim/2.0/tenantId/Assets(AssetId) | Returns the entity with the key from Assets |
XbimAim::AssetsApi | assets_member_access_by_assetid_and_tenantid | GET /region/aim/2.0/tenantId/Assets(AssetId)/MemberAccess | Gets the list of users with access to this item and their permissions |
XbimAim::AssetsApi | assets_patch_by_assetid_and_tenantid | PATCH /region/aim/2.0/tenantId/Assets(AssetId) | Edit an existing asset |
XbimAim::AssetsApi | assets_permissions_by_assetid_and_tenantid | GET /region/aim/2.0/tenantId/Assets(AssetId)/Permissions | Gets the effective permissions for this current user |
XbimAim::AssetsApi | assets_post_by_tenantid | POST /region/aim/2.0/tenantId/Assets | Post a new entity to EntitySet Assets |
XbimAim::AssetsApi | assets_revoke_by_tenantid_and_assetid | POST /region/aim/2.0/tenantId/Assets(AssetId)/Roles.Revoke | Revokes a user from the given role on the asset |
XbimAim::AssetsApi | assets_roles_by_assetid_and_tenantid | GET /region/aim/2.0/tenantId/Assets(AssetId)/Roles | Gets the roles for the given Asset |
XbimAim::AttributesApi | attributes_change_data_type_by_assetmodelid_and_definitionid_and_tenantid | POST /region/aim/2.0/tenantId/Attributes(AssetModelId=assetModelId,AttributeDefinitionId=definitionId)/ChangeDataType() | Change the underlying data type for the attribute, migrating any existing data where possible |
XbimAim::AttributesApi | attributes_get_by_assetmodelid_and_definitionid_and_tenantid | GET /region/aim/2.0/tenantId/Attributes(AssetModelId=assetModelId,AttributeDefinitionId=definitionId) | Operation to interrogate a single attribute definition |
XbimAim::AttributesApi | attributes_get_by_tenantid | GET /region/aim/2.0/tenantId/Attributes | Returns the EntitySet Attributes |
XbimAim::AttributesApi | attributes_get_model_values_by_assetmodelid_and_definitionid_and_tenantid | GET /region/aim/2.0/tenantId/Attributes(AssetModelId=assetModelId,AttributeDefinitionId=definitionId)/GetModelValues() | Gets a sample of the attribute values for the definition |
XbimAim::AttributesApi | attributes_get_values_for_entity_by_assetmodelid_and_entityid_and_tenantid | GET /region/aim/2.0/tenantId/Attributes/GetValuesForEntity(assetModelId=assetModelId,entityId=entityId) | Gets the unimported attribute values for an entity from the source model |
XbimAim::AttributesApi | attributes_import_by_assetmodelid_and_definitionid_and_tenantid | POST /region/aim/2.0/tenantId/Attributes(AssetModelId=assetModelId,AttributeDefinitionId=definitionId)/Import() | Imports attribute values from the source model file |
XbimAim::AttributesApi | attributes_patch_by_assetmodelid_and_definitionid_and_tenantid | PATCH /region/aim/2.0/tenantId/Attributes(AssetModelId=assetModelId,AttributeDefinitionId=definitionId) | Update an AttributeDefinition for a model |
XbimAim::AttributesApi | attributes_post_by_tenantid | POST /region/aim/2.0/tenantId/Attributes | Creates a new AttributeDefinition for a model |
XbimAim::ComponentTypesApi | component_types_add_document_by_assetmodelid_and_entityid_and_tenantid | POST /region/aim/2.0/tenantId/ComponentTypes(AssetModelId=assetModelId, EntityId=entityId)/DocumentEntities | Adds a new document to a model entity |
XbimAim::ComponentTypesApi | component_types_as_of_by_date_and_tenantid | GET /region/aim/2.0/tenantId/ComponentTypes/AsOf(date=date) | Get ComponentTypes as of by date and tenantid |
XbimAim::ComponentTypesApi | component_types_get_available_properties_by_assetid_and_tenantid | GET /region/aim/2.0/tenantId/ComponentTypes/GetAvailableProperties(assetId=assetId) | Gets the Properties available on this Model |
XbimAim::ComponentTypesApi | component_types_get_by_tenantid | GET /region/aim/2.0/tenantId/ComponentTypes | Returns the EntitySet ComponentTypes |
XbimAim::ComponentTypesApi | component_types_get_single_entity_by_assetmodelid_and_entityid_and_tenantid | GET /region/aim/2.0/tenantId/ComponentTypes(AssetModelId=assetModelId, EntityId=entityId) | Get ComponentTypes single entity by assetmodelid, entityid and tenantid |
XbimAim::ComponentTypesApi | component_types_patch_by_assetmodelid_and_entityid_and_tenantid | PATCH /region/aim/2.0/tenantId/ComponentTypes(AssetModelId=AssetModelId, EntityId=EntityId) | Patch ComponentTypes by assetmodelid, entityid and tenantid |
XbimAim::ComponentTypesApi | component_types_post_by_tenantid | POST /region/aim/2.0/tenantId/ComponentTypes | Post a new entity to EntitySet ComponentTypes |
XbimAim::ComponentsApi | components_add_document_by_assetmodelid_and_entityid_and_tenantid | POST /region/aim/2.0/tenantId/Components(AssetModelId=assetModelId, EntityId=entityId)/DocumentEntities | Adds a new document to a model entity |
XbimAim::ComponentsApi | components_as_of_by_date_and_tenantid | GET /region/aim/2.0/tenantId/Components/AsOf(date=date) | Get Components as of by date and tenantid |
XbimAim::ComponentsApi | components_containing_spaces_by_assetmodelid_and_entityid_and_tenantid | GET /region/aim/2.0/tenantId/Components(AssetModelId=assetModelId, EntityId=entityId)/ContainingSpaces | Gets the Spaces this Component is placed in, based on Footprint data |
XbimAim::ComponentsApi | components_get_available_properties_by_assetid_and_tenantid | GET /region/aim/2.0/tenantId/Components/GetAvailableProperties(assetId=assetId) | Gets the Properties available on this Model |
XbimAim::ComponentsApi | components_get_by_tenantid | GET /region/aim/2.0/tenantId/Components | Returns the EntitySet Components |
XbimAim::ComponentsApi | components_get_single_entity_by_assetmodelid_and_entityid_and_tenantid | GET /region/aim/2.0/tenantId/Components(AssetModelId=assetModelId, EntityId=entityId) | Get Components single entity by assetmodelid, entityid and tenantid |
XbimAim::ComponentsApi | components_patch_by_assetmodelid_and_entityid_and_tenantid | PATCH /region/aim/2.0/tenantId/Components(AssetModelId=AssetModelId, EntityId=EntityId) | Edit an existing component |
XbimAim::ComponentsApi | components_post_by_tenantid | POST /region/aim/2.0/tenantId/Components | Adds a new Component to a model |
XbimAim::ContactsApi | contacts_add_document_by_assetmodelid_and_entityid_and_tenantid | POST /region/aim/2.0/tenantId/Contacts(AssetModelId=assetModelId, EntityId=entityId)/DocumentEntities | Adds a new document to a model entity |
XbimAim::ContactsApi | contacts_as_of_by_date_and_tenantid | GET /region/aim/2.0/tenantId/Contacts/AsOf(date=date) | Get Contacts as of by date and tenantid |
XbimAim::ContactsApi | contacts_get_available_properties_by_assetid_and_tenantid | GET /region/aim/2.0/tenantId/Contacts/GetAvailableProperties(assetId=assetId) | Gets the Properties available on this Model |
XbimAim::ContactsApi | contacts_get_by_tenantid | GET /region/aim/2.0/tenantId/Contacts | Returns the EntitySet Contacts |
XbimAim::ContactsApi | contacts_get_single_entity_by_assetmodelid_and_entityid_and_tenantid | GET /region/aim/2.0/tenantId/Contacts(AssetModelId=assetModelId, EntityId=entityId) | Get Contacts single entity by assetmodelid, entityid and tenantid |
XbimAim::ContactsApi | contacts_patch_by_assetmodelid_and_entityid_and_tenantid | PATCH /region/aim/2.0/tenantId/Contacts(AssetModelId=AssetModelId, EntityId=EntityId) | Patch Contacts by assetmodelid, entityid and tenantid |
XbimAim::ContactsApi | contacts_post_by_tenantid | POST /region/aim/2.0/tenantId/Contacts | Post a new entity to EntitySet Contacts |
XbimAim::DiagnosticsApi | diagnostics_get | GET /region/aim/2.0/Diagnostics | Returns the EntitySet Diagnostics |
XbimAim::DocumentFilesApi | document_files_get_file | GET /region/aim/2.0/tenantId/documentfiles/download/assetId/modelId/fileId | Downloads binary file related to asset and model |
XbimAim::DocumentFilesApi | document_files_upload_single_file | POST /region/aim/2.0/tenantId/documentfiles/upload | Uploads a document file related to a specific model |
XbimAim::DocumentsApi | documents_add_document_by_assetmodelid_and_entityid_and_tenantid | POST /region/aim/2.0/tenantId/Documents(AssetModelId=assetModelId, EntityId=entityId)/DocumentEntities | Adds a new document to a model entity |
XbimAim::DocumentsApi | documents_as_of_by_date_and_tenantid | GET /region/aim/2.0/tenantId/Documents/AsOf(date=date) | Get Documents as of by date and tenantid |
XbimAim::DocumentsApi | documents_get_available_properties_by_assetid_and_tenantid | GET /region/aim/2.0/tenantId/Documents/GetAvailableProperties(assetId=assetId) | Gets the Properties available on this Model |
XbimAim::DocumentsApi | documents_get_by_tenantid | GET /region/aim/2.0/tenantId/Documents | Returns the EntitySet Documents |
XbimAim::DocumentsApi | documents_get_single_entity_by_assetmodelid_and_entityid_and_tenantid | GET /region/aim/2.0/tenantId/Documents(AssetModelId=assetModelId, EntityId=entityId) | Get Documents single entity by assetmodelid, entityid and tenantid |
XbimAim::DocumentsApi | documents_patch_by_assetmodelid_and_entityid_and_tenantid | PATCH /region/aim/2.0/tenantId/Documents(AssetModelId=AssetModelId, EntityId=EntityId) | Patch Documents by assetmodelid, entityid and tenantid |
XbimAim::DocumentsApi | documents_post_by_tenantid | POST /region/aim/2.0/tenantId/Documents | Post a new entity to EntitySet Documents |
XbimAim::EntitiesApi | entities_add_document_by_assetmodelid_and_entityid_and_tenantid | POST /region/aim/2.0/tenantId/Entities(AssetModelId=assetModelId, EntityId=entityId)/DocumentEntities | Adds a new document to a model entity |
XbimAim::EntitiesApi | entities_as_of_by_date_and_tenantid | GET /region/aim/2.0/tenantId/Entities/AsOf(date=date) | Get Entities as of by date and tenantid |
XbimAim::EntitiesApi | entities_as_of_by_kind | GET /region/aim/2.0/tenantId/Entities/AsOf(date=date,entityKind=entityKind) | Query a set of Entities at a point in time |
XbimAim::EntitiesApi | entities_get_available_properties_by_assetid_and_tenantid | GET /region/aim/2.0/tenantId/Entities/GetAvailableProperties(assetId=assetId) | Gets the Properties available on this Model |
XbimAim::EntitiesApi | entities_get_by_tenantid | GET /region/aim/2.0/tenantId/Entities | Returns the EntitySet Entities |
XbimAim::EntitiesApi | entities_get_single_entity_by_assetmodelid_and_entityid_and_tenantid | GET /region/aim/2.0/tenantId/Entities(AssetModelId=assetModelId, EntityId=entityId) | Get Entities single entity by assetmodelid, entityid and tenantid |
XbimAim::EntitiesApi | entities_lookup_by_tenantid | POST /region/aim/2.0/tenantId/Entities/Guids.Lookup | Provides the xbim flex identities for a set of provided IfcGuids |
XbimAim::EntitiesApi | entities_patch_by_assetmodelid_and_entityid_and_tenantid | PATCH /region/aim/2.0/tenantId/Entities(AssetModelId=AssetModelId, EntityId=EntityId) | Patch Entities by assetmodelid, entityid and tenantid |
XbimAim::EntitiesApi | entities_post_by_tenantid | POST /region/aim/2.0/tenantId/Entities | Post a new entity to EntitySet Entities |
XbimAim::FacilitiesApi | facilities_add_document_by_assetmodelid_and_entityid_and_tenantid | POST /region/aim/2.0/tenantId/Facilities(AssetModelId=assetModelId, EntityId=entityId)/DocumentEntities | Adds a new document to a model entity |
XbimAim::FacilitiesApi | facilities_as_of_by_date_and_tenantid | GET /region/aim/2.0/tenantId/Facilities/AsOf(date=date) | Get Facilities as of by date and tenantid |
XbimAim::FacilitiesApi | facilities_get_available_properties_by_assetid_and_tenantid | GET /region/aim/2.0/tenantId/Facilities/GetAvailableProperties(assetId=assetId) | Gets the Properties available on this Model |
XbimAim::FacilitiesApi | facilities_get_by_tenantid | GET /region/aim/2.0/tenantId/Facilities | Returns the EntitySet Facilities |
XbimAim::FacilitiesApi | facilities_get_single_entity_by_assetmodelid_and_entityid_and_tenantid | GET /region/aim/2.0/tenantId/Facilities(AssetModelId=assetModelId, EntityId=entityId) | Get Facilities single entity by assetmodelid, entityid and tenantid |
XbimAim::FacilitiesApi | facilities_patch_by_assetmodelid_and_entityid_and_tenantid | PATCH /region/aim/2.0/tenantId/Facilities(AssetModelId=AssetModelId, EntityId=EntityId) | Patch Facilities by assetmodelid, entityid and tenantid |
XbimAim::FacilitiesApi | facilities_post_by_tenantid | POST /region/aim/2.0/tenantId/Facilities | Post a new entity to EntitySet Facilities |
XbimAim::IssuesApi | issues_add_document_by_assetmodelid_and_entityid_and_tenantid | POST /region/aim/2.0/tenantId/Issues(AssetModelId=assetModelId, EntityId=entityId)/DocumentEntities | Adds a new document to a model entity |
XbimAim::IssuesApi | issues_as_of_by_date_and_tenantid | GET /region/aim/2.0/tenantId/Issues/AsOf(date=date) | Get Issues as of by date and tenantid |
XbimAim::IssuesApi | issues_get_available_properties_by_assetid_and_tenantid | GET /region/aim/2.0/tenantId/Issues/GetAvailableProperties(assetId=assetId) | Gets the Properties available on this Model |
XbimAim::IssuesApi | issues_get_by_tenantid | GET /region/aim/2.0/tenantId/Issues | Returns the EntitySet Issues |
XbimAim::IssuesApi | issues_get_single_entity_by_assetmodelid_and_entityid_and_tenantid | GET /region/aim/2.0/tenantId/Issues(AssetModelId=assetModelId, EntityId=entityId) | Get Issues single entity by assetmodelid, entityid and tenantid |
XbimAim::IssuesApi | issues_patch_by_assetmodelid_and_entityid_and_tenantid | PATCH /region/aim/2.0/tenantId/Issues(AssetModelId=AssetModelId, EntityId=EntityId) | Patch Issues by assetmodelid, entityid and tenantid |
XbimAim::IssuesApi | issues_post_by_tenantid | POST /region/aim/2.0/tenantId/Issues | Post a new entity to EntitySet Issues |
XbimAim::JobsApi | jobs_add_document_by_assetmodelid_and_entityid_and_tenantid | POST /region/aim/2.0/tenantId/Jobs(AssetModelId=assetModelId, EntityId=entityId)/DocumentEntities | Adds a new document to a model entity |
XbimAim::JobsApi | jobs_as_of_by_date_and_tenantid | GET /region/aim/2.0/tenantId/Jobs/AsOf(date=date) | Get Jobs as of by date and tenantid |
XbimAim::JobsApi | jobs_get_available_properties_by_assetid_and_tenantid | GET /region/aim/2.0/tenantId/Jobs/GetAvailableProperties(assetId=assetId) | Gets the Properties available on this Model |
XbimAim::JobsApi | jobs_get_by_tenantid | GET /region/aim/2.0/tenantId/Jobs | Returns the EntitySet Jobs |
XbimAim::JobsApi | jobs_get_single_entity_by_assetmodelid_and_entityid_and_tenantid | GET /region/aim/2.0/tenantId/Jobs(AssetModelId=assetModelId, EntityId=entityId) | Get Jobs single entity by assetmodelid, entityid and tenantid |
XbimAim::JobsApi | jobs_patch_by_assetmodelid_and_entityid_and_tenantid | PATCH /region/aim/2.0/tenantId/Jobs(AssetModelId=AssetModelId, EntityId=EntityId) | Patch Jobs by assetmodelid, entityid and tenantid |
XbimAim::JobsApi | jobs_post_by_tenantid | POST /region/aim/2.0/tenantId/Jobs | Post a new entity to EntitySet Jobs |
XbimAim::LevelsApi | levels_add_document_by_assetmodelid_and_entityid_and_tenantid | POST /region/aim/2.0/tenantId/Levels(AssetModelId=assetModelId, EntityId=entityId)/DocumentEntities | Adds a new document to a model entity |
XbimAim::LevelsApi | levels_as_of_by_date_and_tenantid | GET /region/aim/2.0/tenantId/Levels/AsOf(date=date) | Get Levels as of by date and tenantid |
XbimAim::LevelsApi | levels_get_available_properties_by_assetid_and_tenantid | GET /region/aim/2.0/tenantId/Levels/GetAvailableProperties(assetId=assetId) | Gets the Properties available on this Model |
XbimAim::LevelsApi | levels_get_by_tenantid | GET /region/aim/2.0/tenantId/Levels | Returns the EntitySet Levels |
XbimAim::LevelsApi | levels_get_single_entity_by_assetmodelid_and_entityid_and_tenantid | GET /region/aim/2.0/tenantId/Levels(AssetModelId=assetModelId, EntityId=entityId) | Get Levels single entity by assetmodelid, entityid and tenantid |
XbimAim::LevelsApi | levels_patch_by_assetmodelid_and_entityid_and_tenantid | PATCH /region/aim/2.0/tenantId/Levels(AssetModelId=AssetModelId, EntityId=EntityId) | Patch Levels by assetmodelid, entityid and tenantid |
XbimAim::LevelsApi | levels_post_by_tenantid | POST /region/aim/2.0/tenantId/Levels | Post a new entity to EntitySet Levels |
XbimAim::LogsApi | logs_ingest_logs | POST /region/aim/2.0/logs/ImportJson | Imports a batch of logs to the central logging service |
XbimAim::ModelFilesApi | model_files_get_file | GET /region/aim/2.0/tenantId/modelfiles/download/assetId/modelId | Downloads the model as originally uploaded |
XbimAim::ModelFilesApi | model_files_upload_single_file | POST /region/aim/2.0/tenantId/modelfiles/upload | A one-stop service for Uploading an IFC model file, creating an asset and Model as required, and initiating processing |
XbimAim::ModelMappingApi | model_mapping_get_by_mappingid_and_tenantid | GET /region/aim/2.0/tenantId/ModelMapping(MappingId) | Get a single Mapping by its key |
XbimAim::ModelMappingApi | model_mapping_get_by_tenantid | GET /region/aim/2.0/tenantId/ModelMapping | Returns the EntitySet ModelMapping |
XbimAim::ModelsApi | models_assign_by_tenantid_and_assetmodelid | POST /region/aim/2.0/tenantId/Models(AssetModelId)/Roles.Assign | Assigns a user to the given role on the model |
XbimAim::ModelsApi | models_delete_by_assetmodelid_and_tenantid | DELETE /region/aim/2.0/tenantId/Models(AssetModelId) | Archive a model for future deletion |
XbimAim::ModelsApi | models_generate_model_mapping_by_assetmodelid_and_targetmodelid_and_tenantid | POST /region/aim/2.0/tenantId/Models(AssetModelId)/GenerateModelMapping(id=targetModelId) | Generates a model mappings between two distinct models |
XbimAim::ModelsApi | models_get_by_tenantid | GET /region/aim/2.0/tenantId/Models | Returns the EntitySet Models |
XbimAim::ModelsApi | models_get_single_by_assetmodelid_and_tenantid | GET /region/aim/2.0/tenantId/Models(AssetModelId) | Returns the entity with the key from Models |
XbimAim::ModelsApi | models_member_access_by_assetmodelid_and_tenantid | GET /region/aim/2.0/tenantId/Models(AssetModelId)/MemberAccess | Gets the list of users with access to this model and their permissions |
XbimAim::ModelsApi | models_move_by_tenantid_and_assetmodelid | POST /region/aim/2.0/tenantId/Models(AssetModelId)/Asset.Move | Move a model to another asset in this tenant |
XbimAim::ModelsApi | models_patch_by_assetmodelid_and_tenantid | PATCH /region/aim/2.0/tenantId/Models(AssetModelId) | Edit an existing model |
XbimAim::ModelsApi | models_permissions_by_assetmodelid_and_tenantid | GET /region/aim/2.0/tenantId/Models(AssetModelId)/Permissions | Gets the effective permissions for the current user |
XbimAim::ModelsApi | models_post_by_tenantid | POST /region/aim/2.0/tenantId/Models | Creates a new Model for the given Asset |
XbimAim::ModelsApi | models_reprocess_by_assetmodelid_and_tenantid | POST /region/aim/2.0/tenantId/Models(AssetModelId)/Reprocess() | Requeues a model for processing and import |
XbimAim::ModelsApi | models_revoke_by_tenantid_and_assetmodelid | POST /region/aim/2.0/tenantId/Models(AssetModelId)/Roles.Revoke | Revokes a user from the given role on the model |
XbimAim::ModelsApi | models_roles_by_assetmodelid_and_tenantid | GET /region/aim/2.0/tenantId/Models(AssetModelId)/Roles | Gets the roles for the given Model |
XbimAim::ModelsApi | models_supercede_by_key_and_tenantid | POST /region/aim/2.0/tenantId/Models(key)/Supercede() | Supercede an existing model with a new version |
XbimAim::ResourcesApi | resources_add_document_by_assetmodelid_and_entityid_and_tenantid | POST /region/aim/2.0/tenantId/Resources(AssetModelId=assetModelId, EntityId=entityId)/DocumentEntities | Adds a new document to a model entity |
XbimAim::ResourcesApi | resources_as_of_by_date_and_tenantid | GET /region/aim/2.0/tenantId/Resources/AsOf(date=date) | Get Resources as of by date and tenantid |
XbimAim::ResourcesApi | resources_get_available_properties_by_assetid_and_tenantid | GET /region/aim/2.0/tenantId/Resources/GetAvailableProperties(assetId=assetId) | Gets the Properties available on this Model |
XbimAim::ResourcesApi | resources_get_by_tenantid | GET /region/aim/2.0/tenantId/Resources | Returns the EntitySet Resources |
XbimAim::ResourcesApi | resources_get_single_entity_by_assetmodelid_and_entityid_and_tenantid | GET /region/aim/2.0/tenantId/Resources(AssetModelId=assetModelId, EntityId=entityId) | Get Resources single entity by assetmodelid, entityid and tenantid |
XbimAim::ResourcesApi | resources_patch_by_assetmodelid_and_entityid_and_tenantid | PATCH /region/aim/2.0/tenantId/Resources(AssetModelId=AssetModelId, EntityId=EntityId) | Patch Resources by assetmodelid, entityid and tenantid |
XbimAim::ResourcesApi | resources_post_by_tenantid | POST /region/aim/2.0/tenantId/Resources | Post a new entity to EntitySet Resources |
XbimAim::SchedulesApi | schedules_get_schedule_by_tenantid | GET /region/aim/2.0/tenantId/Schedules(AssetModelId,ScheduleName) | Get Schedules schedule by tenantid |
XbimAim::SchedulesApi | schedules_get_schedule_rows_by_assetmodelid_and_schedulename_and_tenantid | GET /region/aim/2.0/tenantId/Schedules(assetModelId,'scheduleName')/Rows | Get Schedules schedule rows by assetmodelid, schedulename and tenantid |
XbimAim::SchedulesApi | schedules_get_schedules_by_tenantid | GET /region/aim/2.0/tenantId/Schedules | Returns the EntitySet Schedules |
XbimAim::SchedulesApi | schedules_import_schedule_by_modelid_and_schedule_and_tenantid | POST /region/aim/2.0/tenantId/Schedules/Import(AssetModelId=modelId,ScheduleName='schedule') | Post Schedules import schedule by modelid, schedule and tenantid |
XbimAim::SitesApi | sites_add_document_by_assetmodelid_and_entityid_and_tenantid | POST /region/aim/2.0/tenantId/Sites(AssetModelId=assetModelId, EntityId=entityId)/DocumentEntities | Adds a new document to a model entity |
XbimAim::SitesApi | sites_as_of_by_date_and_tenantid | GET /region/aim/2.0/tenantId/Sites/AsOf(date=date) | Get Sites as of by date and tenantid |
XbimAim::SitesApi | sites_get_available_properties_by_assetid_and_tenantid | GET /region/aim/2.0/tenantId/Sites/GetAvailableProperties(assetId=assetId) | Gets the Properties available on this Model |
XbimAim::SitesApi | sites_get_by_tenantid | GET /region/aim/2.0/tenantId/Sites | Returns the EntitySet Sites |
XbimAim::SitesApi | sites_get_single_entity_by_assetmodelid_and_entityid_and_tenantid | GET /region/aim/2.0/tenantId/Sites(AssetModelId=assetModelId, EntityId=entityId) | Get Sites single entity by assetmodelid, entityid and tenantid |
XbimAim::SitesApi | sites_patch_by_assetmodelid_and_entityid_and_tenantid | PATCH /region/aim/2.0/tenantId/Sites(AssetModelId=AssetModelId, EntityId=EntityId) | Patch Sites by assetmodelid, entityid and tenantid |
XbimAim::SitesApi | sites_post_by_tenantid | POST /region/aim/2.0/tenantId/Sites | Post a new entity to EntitySet Sites |
XbimAim::SpacesApi | spaces_add_document_by_assetmodelid_and_entityid_and_tenantid | POST /region/aim/2.0/tenantId/Spaces(AssetModelId=assetModelId, EntityId=entityId)/DocumentEntities | Adds a new document to a model entity |
XbimAim::SpacesApi | spaces_as_of_by_date_and_tenantid | GET /region/aim/2.0/tenantId/Spaces/AsOf(date=date) | Get Spaces as of by date and tenantid |
XbimAim::SpacesApi | spaces_contained_components_by_assetmodelid_and_entityid_and_tenantid | GET /region/aim/2.0/tenantId/Spaces(AssetModelId=assetModelId, EntityId=entityId)/ContainedComponents | Gets the set of Components which are placed within the Geometry footprint of this Space |
XbimAim::SpacesApi | spaces_get_available_properties_by_assetid_and_tenantid | GET /region/aim/2.0/tenantId/Spaces/GetAvailableProperties(assetId=assetId) | Gets the Properties available on this Model |
XbimAim::SpacesApi | spaces_get_by_tenantid | GET /region/aim/2.0/tenantId/Spaces | Returns the EntitySet Spaces |
XbimAim::SpacesApi | spaces_get_single_entity_by_assetmodelid_and_entityid_and_tenantid | GET /region/aim/2.0/tenantId/Spaces(AssetModelId=assetModelId, EntityId=entityId) | Get Spaces single entity by assetmodelid, entityid and tenantid |
XbimAim::SpacesApi | spaces_patch_by_assetmodelid_and_entityid_and_tenantid | PATCH /region/aim/2.0/tenantId/Spaces(AssetModelId=AssetModelId, EntityId=EntityId) | Edit an existing space |
XbimAim::SpacesApi | spaces_post_by_tenantid | POST /region/aim/2.0/tenantId/Spaces | Adds a new Space to a model |
XbimAim::SparesApi | spares_add_document_by_assetmodelid_and_entityid_and_tenantid | POST /region/aim/2.0/tenantId/Spares(AssetModelId=assetModelId, EntityId=entityId)/DocumentEntities | Adds a new document to a model entity |
XbimAim::SparesApi | spares_as_of_by_date_and_tenantid | GET /region/aim/2.0/tenantId/Spares/AsOf(date=date) | Get Spares as of by date and tenantid |
XbimAim::SparesApi | spares_get_available_properties_by_assetid_and_tenantid | GET /region/aim/2.0/tenantId/Spares/GetAvailableProperties(assetId=assetId) | Gets the Properties available on this Model |
XbimAim::SparesApi | spares_get_by_tenantid | GET /region/aim/2.0/tenantId/Spares | Returns the EntitySet Spares |
XbimAim::SparesApi | spares_get_single_entity_by_assetmodelid_and_entityid_and_tenantid | GET /region/aim/2.0/tenantId/Spares(AssetModelId=assetModelId, EntityId=entityId) | Get Spares single entity by assetmodelid, entityid and tenantid |
XbimAim::SparesApi | spares_patch_by_assetmodelid_and_entityid_and_tenantid | PATCH /region/aim/2.0/tenantId/Spares(AssetModelId=AssetModelId, EntityId=EntityId) | Patch Spares by assetmodelid, entityid and tenantid |
XbimAim::SparesApi | spares_post_by_tenantid | POST /region/aim/2.0/tenantId/Spares | Post a new entity to EntitySet Spares |
XbimAim::StatsApi | stats_metered_resources | GET /region/aim/2.0/tenantId/stats/planAllowances | Lists the plan allowances and current consumpttion for a tenant's app |
XbimAim::StatsApi | stats_rate_limits | GET /region/aim/2.0/tenantId/stats/rateLimits | Provides details of the permitted rate limits for tenant's app and user |
XbimAim::SystemsApi | systems_add_document_by_assetmodelid_and_entityid_and_tenantid | POST /region/aim/2.0/tenantId/Systems(AssetModelId=assetModelId, EntityId=entityId)/DocumentEntities | Adds a new document to a model entity |
XbimAim::SystemsApi | systems_as_of_by_date_and_tenantid | GET /region/aim/2.0/tenantId/Systems/AsOf(date=date) | Get Systems as of by date and tenantid |
XbimAim::SystemsApi | systems_get_available_properties_by_assetid_and_tenantid | GET /region/aim/2.0/tenantId/Systems/GetAvailableProperties(assetId=assetId) | Gets the Properties available on this Model |
XbimAim::SystemsApi | systems_get_by_tenantid | GET /region/aim/2.0/tenantId/Systems | Returns the EntitySet Systems |
XbimAim::SystemsApi | systems_get_single_entity_by_assetmodelid_and_entityid_and_tenantid | GET /region/aim/2.0/tenantId/Systems(AssetModelId=assetModelId, EntityId=entityId) | Get Systems single entity by assetmodelid, entityid and tenantid |
XbimAim::SystemsApi | systems_patch_by_assetmodelid_and_entityid_and_tenantid | PATCH /region/aim/2.0/tenantId/Systems(AssetModelId=AssetModelId, EntityId=EntityId) | Patch Systems by assetmodelid, entityid and tenantid |
XbimAim::SystemsApi | systems_post_by_tenantid | POST /region/aim/2.0/tenantId/Systems | Post a new entity to EntitySet Systems |
XbimAim::ThumbnailsApi | thumbnails_get_asset_thumbnail | GET /region/aim/2.0/tenantId/thumbnails/asset/assetId | Get Thumbnails asset thumbnail |
XbimAim::ThumbnailsApi | thumbnails_post_asset_thumbnail | POST /region/aim/2.0/tenantId/thumbnails/asset/assetId | Post Thumbnails asset thumbnail |
XbimAim::WexbimApi | wexbim_get_complete | GET /region/aim/2.0/tenantId/wexbim/complete | Gets the pre-generated complete wexbim geometry stream for a model |
XbimAim::WexbimApi | wexbim_get_components | GET /region/aim/2.0/tenantId/wexbim/components | Gets the pre-generated components wexbim geometry stream for a model |
XbimAim::WexbimApi | wexbim_get_dynamic | GET /region/aim/2.0/tenantId/wexbim/dynamic | Gets a dynamically generated geometry stream for a model |
XbimAim::WexbimApi | wexbim_get_envelope | GET /region/aim/2.0/tenantId/wexbim/envelope | Gets the pre-generated building envelope wexbim geometry stream for a model |
XbimAim::WexbimApi | wexbim_get_envelope_cut | GET /region/aim/2.0/tenantId/wexbim/envelopecut | Gets the building envelope geometry cut plane. This can be used to cap the holes after clipping. |
XbimAim::WexbimApi | wexbim_get_envelope_free_cut | GET /region/aim/2.0/tenantId/wexbim/envelopefreecut | Gets the a cutplane across the envelope for up to 6 cut planes. |
XbimAim::WexbimApi | wexbim_get_site | GET /region/aim/2.0/tenantId/wexbim/site | Gets the pre-generated Site wexbim geometry stream for a model |
XbimAim::WexbimApi | wexbim_get_spatial_structure | GET /region/aim/2.0/tenantId/wexbim/spatial | Gets the pre-generated spatial wexbim geometry stream for a model |
XbimAim::WexbimApi | wexbim_get_windows_and_doors | GET /region/aim/2.0/tenantId/wexbim/windowsdoors | Gets the pre-generated doors/windows wexbim geometry stream for a model |
XbimAim::ZonesApi | zones_add_document_by_assetmodelid_and_entityid_and_tenantid | POST /region/aim/2.0/tenantId/Zones(AssetModelId=assetModelId, EntityId=entityId)/DocumentEntities | Adds a new document to a model entity |
XbimAim::ZonesApi | zones_as_of_by_date_and_tenantid | GET /region/aim/2.0/tenantId/Zones/AsOf(date=date) | Get Zones as of by date and tenantid |
XbimAim::ZonesApi | zones_get_available_properties_by_assetid_and_tenantid | GET /region/aim/2.0/tenantId/Zones/GetAvailableProperties(assetId=assetId) | Gets the Properties available on this Model |
XbimAim::ZonesApi | zones_get_by_tenantid | GET /region/aim/2.0/tenantId/Zones | Returns the EntitySet Zones |
XbimAim::ZonesApi | zones_get_single_entity_by_assetmodelid_and_entityid_and_tenantid | GET /region/aim/2.0/tenantId/Zones(AssetModelId=assetModelId, EntityId=entityId) | Get Zones single entity by assetmodelid, entityid and tenantid |
XbimAim::ZonesApi | zones_patch_by_assetmodelid_and_entityid_and_tenantid | PATCH /region/aim/2.0/tenantId/Zones(AssetModelId=AssetModelId, EntityId=EntityId) | Patch Zones by assetmodelid, entityid and tenantid |
XbimAim::ZonesApi | zones_post_by_tenantid | POST /region/aim/2.0/tenantId/Zones | Post a new entity to EntitySet Zones |
Documentation for Models
- XbimAim::Application
- XbimAim::AssemblyDiagnostics
- XbimAim::AssemblyInfo
- XbimAim::AssemblyItem
- XbimAim::Asset
- XbimAim::AssetCreate
- XbimAim::AssetEdit
- XbimAim::AssetSegment
- XbimAim::AttributeDefinition
- XbimAim::AttributeDefinitionCreate
- XbimAim::AttributeDefinitionEdit
- XbimAim::AttributeDefinitionEntity
- XbimAim::AttributeValue
- XbimAim::AttributeValueEntity
- XbimAim::Cell
- XbimAim::ClassificationNode
- XbimAim::ColumnDefinition
- XbimAim::ComplexValueBase
- XbimAim::Component
- XbimAim::ComponentCreate
- XbimAim::ComponentEdit
- XbimAim::ComponentInfo
- XbimAim::ComponentType
- XbimAim::ComponentTypeInfo
- XbimAim::Contact
- XbimAim::ContactEntity
- XbimAim::ContactInfo
- XbimAim::DbUpdate
- XbimAim::Document
- XbimAim::DocumentCreate
- XbimAim::DocumentEdit
- XbimAim::DocumentInfo
- XbimAim::Entity
- XbimAim::EntityBase
- XbimAim::EntityContact
- XbimAim::EntityCreate
- XbimAim::EntityEdit
- XbimAim::EntityMappingInfo
- XbimAim::EntityMatchDescriptor
- XbimAim::EntityMatchInfo
- XbimAim::EntityRef
- XbimAim::Facility
- XbimAim::FacilityInfo
- XbimAim::FileUploadResult
- XbimAim::Footprint
- XbimAim::IMeteredResource
- XbimAim::IfcType
- XbimAim::InlineObject
- XbimAim::InlineObject1
- XbimAim::InlineObject2
- XbimAim::InlineObject3
- XbimAim::InlineObject4
- XbimAim::InlineObject5
- XbimAim::Issue
- XbimAim::IssueInfo
- XbimAim::Job
- XbimAim::JobCreate
- XbimAim::JobEdit
- XbimAim::JobInfo
- XbimAim::Level
- XbimAim::LevelCreate
- XbimAim::LevelEdit
- XbimAim::LevelInfo
- XbimAim::MappingMessageInfo
- XbimAim::MappingProperties
- XbimAim::MemberPermission
- XbimAim::MemberRole
- XbimAim::Model
- XbimAim::ModelCreate
- XbimAim::ModelEdit
- XbimAim::ModelInfo
- XbimAim::ModelMapping
- XbimAim::ModelMappingReport
- XbimAim::ODataListResponseOfApplication
- XbimAim::ODataListResponseOfAssemblyDiagnostics
- XbimAim::ODataListResponseOfAssemblyItem
- XbimAim::ODataListResponseOfAsset
- XbimAim::ODataListResponseOfAttributeDefinition
- XbimAim::ODataListResponseOfAttributeDefinitionEntity
- XbimAim::ODataListResponseOfAttributeValue
- XbimAim::ODataListResponseOfComplexValueBase
- XbimAim::ODataListResponseOfComponent
- XbimAim::ODataListResponseOfComponentType
- XbimAim::ODataListResponseOfContact
- XbimAim::ODataListResponseOfDocument
- XbimAim::ODataListResponseOfEntity
- XbimAim::ODataListResponseOfEntityRef
- XbimAim::ODataListResponseOfFacility
- XbimAim::ODataListResponseOfIssue
- XbimAim::ODataListResponseOfJob
- XbimAim::ODataListResponseOfLevel
- XbimAim::ODataListResponseOfMemberPermission
- XbimAim::ODataListResponseOfModel
- XbimAim::ODataListResponseOfModelMapping
- XbimAim::ODataListResponseOfModelMappingReport
- XbimAim::ODataListResponseOfResource
- XbimAim::ODataListResponseOfRole
- XbimAim::ODataListResponseOfRow
- XbimAim::ODataListResponseOfSchedule
- XbimAim::ODataListResponseOfSite
- XbimAim::ODataListResponseOfSpace
- XbimAim::ODataListResponseOfSpare
- XbimAim::ODataListResponseOfSystemItem
- XbimAim::ODataListResponseOfZone
- XbimAim::ODataResponseOfBoolean
- XbimAim::QuotaStatus
- XbimAim::RelatedEntity
- XbimAim::Resource
- XbimAim::ResourceInfo
- XbimAim::Role
- XbimAim::RoleMember
- XbimAim::Row
- XbimAim::Schedule
- XbimAim::Site
- XbimAim::Space
- XbimAim::SpaceCreate
- XbimAim::SpaceEdit
- XbimAim::SpaceInfo
- XbimAim::Spare
- XbimAim::SpareCreate
- XbimAim::SpareEdit
- XbimAim::SpareInfo
- XbimAim::SystemInfo
- XbimAim::SystemItem
- XbimAim::UserPermissions
- XbimAim::ValueContainer
- XbimAim::Zone
- XbimAim::ZoneInfo
Documentation for Authorization
oauth2
- Type: OAuth
- Flow: implicit
- Authorization URL: https://apis.xbim-dev.net/connect/authorize
- Scopes:
- api.read: Read-only access to Asset data
- api.write: Manage your Asset data
- api.admin: Administer the API