xbim_aim

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

This Dart package is automatically generated by the OpenAPI Generator project:

  • API version: 2.0
  • Build package: org.openapitools.codegen.languages.DartClientCodegen For more information, please visit https://xbim.net

Requirements

Dart 2.0 or later

Installation & Usage

Github

If this Dart package is published to Github, add the following dependency to your pubspec.yaml

dependencies:
  xbim_aim:
    git: https://github.com/GIT_USER_ID/GIT_REPO_ID.git

Local

To use the package in your local drive, add the following dependency to your pubspec.yaml

dependencies:
  xbim_aim:
    path: /path/to/xbim_aim

Tests

TODO

Getting Started

Please follow the installation procedure and then run the following:

import 'package:xbim_aim/api.dart';

// TODO Configure OAuth2 access token for authorization: oauth2
//defaultApiClient.getAuthentication<OAuth>('oauth2').accessToken = 'YOUR_ACCESS_TOKEN';

final api_instance = AdminApi();
final region = region_example; // String | The data center region the data resides in

try {
    final result = api_instance.adminAppliedUpdates(region);
    print(result);
} catch (e) {
    print('Exception when calling AdminApi->adminAppliedUpdates: $e\n');
}

Documentation for API Endpoints

All URIs are relative to https://apis.xbim-dev.net

Class Method HTTP request Description
AdminApi adminAppliedUpdates GET /{region}/aim/2.0/admin/schema/AppliedUpdates Lists the Database schema updates already installed
AdminApi adminFlushCaches POST /{region}/aim/2.0/admin/schema/FlushCaches Flushes the Flex caches
AdminApi adminGetIsCurrent GET /{region}/aim/2.0/admin/schema/IsCurrent Returns a flag indicating if the database schema requires an upgrade
AdminApi adminPendingUpdates GET /{region}/aim/2.0/admin/schema/PendingUpdates Lists the Database schema updates required
AdminApi adminUpdateSchema POST /{region}/aim/2.0/admin/schema/UpdateSchema Updates the Database schemas to the latest version
ApplicationsApi applicationsGetByTenantid GET /{region}/aim/2.0/{tenantId}/Applications Returns the EntitySet Applications
ApplicationsApi applicationsGetSingleByApplicationidAndTenantid GET /{region}/aim/2.0/{tenantId}/Applications({ApplicationId}) Returns the entity with the key from Applications
AssembliesApi assembliesAddDocumentByAssetmodelidAndEntityidAndTenantid POST /{region}/aim/2.0/{tenantId}/Assemblies(AssetModelId={assetModelId}, EntityId={entityId})/DocumentEntities Adds a new document to a model entity
AssembliesApi assembliesAsOfByDateAndTenantid GET /{region}/aim/2.0/{tenantId}/Assemblies/AsOf(date={date}) Get Assemblies as of by date and tenantid
AssembliesApi assembliesGetAvailablePropertiesByAssetidAndTenantid GET /{region}/aim/2.0/{tenantId}/Assemblies/GetAvailableProperties(assetId={assetId}) Gets the Properties available on this Model
AssembliesApi assembliesGetByTenantid GET /{region}/aim/2.0/{tenantId}/Assemblies Returns the EntitySet Assemblies
AssembliesApi assembliesGetSingleEntityByAssetmodelidAndEntityidAndTenantid GET /{region}/aim/2.0/{tenantId}/Assemblies(AssetModelId={assetModelId}, EntityId={entityId}) Get Assemblies single entity by assetmodelid, entityid and tenantid
AssembliesApi assembliesPatchByAssetmodelidAndEntityidAndTenantid PATCH /{region}/aim/2.0/{tenantId}/Assemblies(AssetModelId={AssetModelId}, EntityId={EntityId}) Patch Assemblies by assetmodelid, entityid and tenantid
AssembliesApi assembliesPostByTenantid POST /{region}/aim/2.0/{tenantId}/Assemblies Post a new entity to EntitySet Assemblies
AssetsApi assetsAssignByTenantidAndAssetid POST /{region}/aim/2.0/{tenantId}/Assets({AssetId})/Roles.Assign Assigns a user to the given role on the asset
AssetsApi assetsDeleteByAssetidAndTenantid DELETE /{region}/aim/2.0/{tenantId}/Assets({AssetId}) Archive an Asset and and models for future deletion
AssetsApi assetsGetByTenantid GET /{region}/aim/2.0/{tenantId}/Assets Returns the EntitySet Assets
AssetsApi assetsGetSingleByAssetidAndTenantid GET /{region}/aim/2.0/{tenantId}/Assets({AssetId}) Returns the entity with the key from Assets
AssetsApi assetsMemberAccessByAssetidAndTenantid GET /{region}/aim/2.0/{tenantId}/Assets({AssetId})/MemberAccess Gets the list of users with access to this item and their permissions
AssetsApi assetsPatchByAssetidAndTenantid PATCH /{region}/aim/2.0/{tenantId}/Assets({AssetId}) Edit an existing asset
AssetsApi assetsPermissionsByAssetidAndTenantid GET /{region}/aim/2.0/{tenantId}/Assets({AssetId})/Permissions Gets the effective permissions for this current user
AssetsApi assetsPostByTenantid POST /{region}/aim/2.0/{tenantId}/Assets Post a new entity to EntitySet Assets
AssetsApi assetsRevokeByTenantidAndAssetid POST /{region}/aim/2.0/{tenantId}/Assets({AssetId})/Roles.Revoke Revokes a user from the given role on the asset
AssetsApi assetsRolesByAssetidAndTenantid GET /{region}/aim/2.0/{tenantId}/Assets({AssetId})/Roles Gets the roles for the given Asset
AttributesApi attributesChangeDataTypeByAssetmodelidAndDefinitionidAndTenantid 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
AttributesApi attributesGetByAssetmodelidAndDefinitionidAndTenantid GET /{region}/aim/2.0/{tenantId}/Attributes(AssetModelId={assetModelId},AttributeDefinitionId={definitionId}) Operation to interrogate a single attribute definition
AttributesApi attributesGetByTenantid GET /{region}/aim/2.0/{tenantId}/Attributes Returns the EntitySet Attributes
AttributesApi attributesGetModelValuesByAssetmodelidAndDefinitionidAndTenantid GET /{region}/aim/2.0/{tenantId}/Attributes(AssetModelId={assetModelId},AttributeDefinitionId={definitionId})/GetModelValues() Gets a sample of the attribute values for the definition
AttributesApi attributesGetValuesForEntityByAssetmodelidAndEntityidAndTenantid GET /{region}/aim/2.0/{tenantId}/Attributes/GetValuesForEntity(assetModelId={assetModelId},entityId={entityId}) Gets the unimported attribute values for an entity from the source model
AttributesApi attributesImportByAssetmodelidAndDefinitionidAndTenantid POST /{region}/aim/2.0/{tenantId}/Attributes(AssetModelId={assetModelId},AttributeDefinitionId={definitionId})/Import() Imports attribute values from the source model file
AttributesApi attributesPatchByAssetmodelidAndDefinitionidAndTenantid PATCH /{region}/aim/2.0/{tenantId}/Attributes(AssetModelId={assetModelId},AttributeDefinitionId={definitionId}) Update an AttributeDefinition for a model
AttributesApi attributesPostByTenantid POST /{region}/aim/2.0/{tenantId}/Attributes Creates a new AttributeDefinition for a model
ComponentTypesApi componentTypesAddDocumentByAssetmodelidAndEntityidAndTenantid POST /{region}/aim/2.0/{tenantId}/ComponentTypes(AssetModelId={assetModelId}, EntityId={entityId})/DocumentEntities Adds a new document to a model entity
ComponentTypesApi componentTypesAsOfByDateAndTenantid GET /{region}/aim/2.0/{tenantId}/ComponentTypes/AsOf(date={date}) Get ComponentTypes as of by date and tenantid
ComponentTypesApi componentTypesGetAvailablePropertiesByAssetidAndTenantid GET /{region}/aim/2.0/{tenantId}/ComponentTypes/GetAvailableProperties(assetId={assetId}) Gets the Properties available on this Model
ComponentTypesApi componentTypesGetByTenantid GET /{region}/aim/2.0/{tenantId}/ComponentTypes Returns the EntitySet ComponentTypes
ComponentTypesApi componentTypesGetSingleEntityByAssetmodelidAndEntityidAndTenantid GET /{region}/aim/2.0/{tenantId}/ComponentTypes(AssetModelId={assetModelId}, EntityId={entityId}) Get ComponentTypes single entity by assetmodelid, entityid and tenantid
ComponentTypesApi componentTypesPatchByAssetmodelidAndEntityidAndTenantid PATCH /{region}/aim/2.0/{tenantId}/ComponentTypes(AssetModelId={AssetModelId}, EntityId={EntityId}) Patch ComponentTypes by assetmodelid, entityid and tenantid
ComponentTypesApi componentTypesPostByTenantid POST /{region}/aim/2.0/{tenantId}/ComponentTypes Post a new entity to EntitySet ComponentTypes
ComponentsApi componentsAddDocumentByAssetmodelidAndEntityidAndTenantid POST /{region}/aim/2.0/{tenantId}/Components(AssetModelId={assetModelId}, EntityId={entityId})/DocumentEntities Adds a new document to a model entity
ComponentsApi componentsAsOfByDateAndTenantid GET /{region}/aim/2.0/{tenantId}/Components/AsOf(date={date}) Get Components as of by date and tenantid
ComponentsApi componentsContainingSpacesByAssetmodelidAndEntityidAndTenantid GET /{region}/aim/2.0/{tenantId}/Components(AssetModelId={assetModelId}, EntityId={entityId})/ContainingSpaces Gets the Spaces this Component is placed in, based on Footprint data
ComponentsApi componentsGetAvailablePropertiesByAssetidAndTenantid GET /{region}/aim/2.0/{tenantId}/Components/GetAvailableProperties(assetId={assetId}) Gets the Properties available on this Model
ComponentsApi componentsGetByTenantid GET /{region}/aim/2.0/{tenantId}/Components Returns the EntitySet Components
ComponentsApi componentsGetSingleEntityByAssetmodelidAndEntityidAndTenantid GET /{region}/aim/2.0/{tenantId}/Components(AssetModelId={assetModelId}, EntityId={entityId}) Get Components single entity by assetmodelid, entityid and tenantid
ComponentsApi componentsPatchByAssetmodelidAndEntityidAndTenantid PATCH /{region}/aim/2.0/{tenantId}/Components(AssetModelId={AssetModelId}, EntityId={EntityId}) Edit an existing component
ComponentsApi componentsPostByTenantid POST /{region}/aim/2.0/{tenantId}/Components Adds a new Component to a model
ContactsApi contactsAddDocumentByAssetmodelidAndEntityidAndTenantid POST /{region}/aim/2.0/{tenantId}/Contacts(AssetModelId={assetModelId}, EntityId={entityId})/DocumentEntities Adds a new document to a model entity
ContactsApi contactsAsOfByDateAndTenantid GET /{region}/aim/2.0/{tenantId}/Contacts/AsOf(date={date}) Get Contacts as of by date and tenantid
ContactsApi contactsGetAvailablePropertiesByAssetidAndTenantid GET /{region}/aim/2.0/{tenantId}/Contacts/GetAvailableProperties(assetId={assetId}) Gets the Properties available on this Model
ContactsApi contactsGetByTenantid GET /{region}/aim/2.0/{tenantId}/Contacts Returns the EntitySet Contacts
ContactsApi contactsGetSingleEntityByAssetmodelidAndEntityidAndTenantid GET /{region}/aim/2.0/{tenantId}/Contacts(AssetModelId={assetModelId}, EntityId={entityId}) Get Contacts single entity by assetmodelid, entityid and tenantid
ContactsApi contactsPatchByAssetmodelidAndEntityidAndTenantid PATCH /{region}/aim/2.0/{tenantId}/Contacts(AssetModelId={AssetModelId}, EntityId={EntityId}) Patch Contacts by assetmodelid, entityid and tenantid
ContactsApi contactsPostByTenantid POST /{region}/aim/2.0/{tenantId}/Contacts Post a new entity to EntitySet Contacts
DiagnosticsApi diagnosticsGet GET /{region}/aim/2.0/Diagnostics Returns the EntitySet Diagnostics
DocumentFilesApi documentFilesGetFile GET /{region}/aim/2.0/{tenantId}/documentfiles/download/{assetId}/{modelId}/{fileId} Downloads binary file related to asset and model
DocumentFilesApi documentFilesUploadSingleFile POST /{region}/aim/2.0/{tenantId}/documentfiles/upload Uploads a document file related to a specific model
DocumentsApi documentsAddDocumentByAssetmodelidAndEntityidAndTenantid POST /{region}/aim/2.0/{tenantId}/Documents(AssetModelId={assetModelId}, EntityId={entityId})/DocumentEntities Adds a new document to a model entity
DocumentsApi documentsAsOfByDateAndTenantid GET /{region}/aim/2.0/{tenantId}/Documents/AsOf(date={date}) Get Documents as of by date and tenantid
DocumentsApi documentsGetAvailablePropertiesByAssetidAndTenantid GET /{region}/aim/2.0/{tenantId}/Documents/GetAvailableProperties(assetId={assetId}) Gets the Properties available on this Model
DocumentsApi documentsGetByTenantid GET /{region}/aim/2.0/{tenantId}/Documents Returns the EntitySet Documents
DocumentsApi documentsGetSingleEntityByAssetmodelidAndEntityidAndTenantid GET /{region}/aim/2.0/{tenantId}/Documents(AssetModelId={assetModelId}, EntityId={entityId}) Get Documents single entity by assetmodelid, entityid and tenantid
DocumentsApi documentsPatchByAssetmodelidAndEntityidAndTenantid PATCH /{region}/aim/2.0/{tenantId}/Documents(AssetModelId={AssetModelId}, EntityId={EntityId}) Patch Documents by assetmodelid, entityid and tenantid
DocumentsApi documentsPostByTenantid POST /{region}/aim/2.0/{tenantId}/Documents Post a new entity to EntitySet Documents
EntitiesApi entitiesAddDocumentByAssetmodelidAndEntityidAndTenantid POST /{region}/aim/2.0/{tenantId}/Entities(AssetModelId={assetModelId}, EntityId={entityId})/DocumentEntities Adds a new document to a model entity
EntitiesApi entitiesAsOfByDateAndTenantid GET /{region}/aim/2.0/{tenantId}/Entities/AsOf(date={date}) Get Entities as of by date and tenantid
EntitiesApi entitiesAsOfByKind GET /{region}/aim/2.0/{tenantId}/Entities/AsOf(date={date},entityKind={entityKind}) Query a set of Entities at a point in time
EntitiesApi entitiesGetAvailablePropertiesByAssetidAndTenantid GET /{region}/aim/2.0/{tenantId}/Entities/GetAvailableProperties(assetId={assetId}) Gets the Properties available on this Model
EntitiesApi entitiesGetByTenantid GET /{region}/aim/2.0/{tenantId}/Entities Returns the EntitySet Entities
EntitiesApi entitiesGetSingleEntityByAssetmodelidAndEntityidAndTenantid GET /{region}/aim/2.0/{tenantId}/Entities(AssetModelId={assetModelId}, EntityId={entityId}) Get Entities single entity by assetmodelid, entityid and tenantid
EntitiesApi entitiesLookupByTenantid POST /{region}/aim/2.0/{tenantId}/Entities/Guids.Lookup Provides the xbim flex identities for a set of provided IfcGuids
EntitiesApi entitiesPatchByAssetmodelidAndEntityidAndTenantid PATCH /{region}/aim/2.0/{tenantId}/Entities(AssetModelId={AssetModelId}, EntityId={EntityId}) Patch Entities by assetmodelid, entityid and tenantid
EntitiesApi entitiesPostByTenantid POST /{region}/aim/2.0/{tenantId}/Entities Post a new entity to EntitySet Entities
FacilitiesApi facilitiesAddDocumentByAssetmodelidAndEntityidAndTenantid POST /{region}/aim/2.0/{tenantId}/Facilities(AssetModelId={assetModelId}, EntityId={entityId})/DocumentEntities Adds a new document to a model entity
FacilitiesApi facilitiesAsOfByDateAndTenantid GET /{region}/aim/2.0/{tenantId}/Facilities/AsOf(date={date}) Get Facilities as of by date and tenantid
FacilitiesApi facilitiesGetAvailablePropertiesByAssetidAndTenantid GET /{region}/aim/2.0/{tenantId}/Facilities/GetAvailableProperties(assetId={assetId}) Gets the Properties available on this Model
FacilitiesApi facilitiesGetByTenantid GET /{region}/aim/2.0/{tenantId}/Facilities Returns the EntitySet Facilities
FacilitiesApi facilitiesGetSingleEntityByAssetmodelidAndEntityidAndTenantid GET /{region}/aim/2.0/{tenantId}/Facilities(AssetModelId={assetModelId}, EntityId={entityId}) Get Facilities single entity by assetmodelid, entityid and tenantid
FacilitiesApi facilitiesPatchByAssetmodelidAndEntityidAndTenantid PATCH /{region}/aim/2.0/{tenantId}/Facilities(AssetModelId={AssetModelId}, EntityId={EntityId}) Patch Facilities by assetmodelid, entityid and tenantid
FacilitiesApi facilitiesPostByTenantid POST /{region}/aim/2.0/{tenantId}/Facilities Post a new entity to EntitySet Facilities
IssuesApi issuesAddDocumentByAssetmodelidAndEntityidAndTenantid POST /{region}/aim/2.0/{tenantId}/Issues(AssetModelId={assetModelId}, EntityId={entityId})/DocumentEntities Adds a new document to a model entity
IssuesApi issuesAsOfByDateAndTenantid GET /{region}/aim/2.0/{tenantId}/Issues/AsOf(date={date}) Get Issues as of by date and tenantid
IssuesApi issuesGetAvailablePropertiesByAssetidAndTenantid GET /{region}/aim/2.0/{tenantId}/Issues/GetAvailableProperties(assetId={assetId}) Gets the Properties available on this Model
IssuesApi issuesGetByTenantid GET /{region}/aim/2.0/{tenantId}/Issues Returns the EntitySet Issues
IssuesApi issuesGetSingleEntityByAssetmodelidAndEntityidAndTenantid GET /{region}/aim/2.0/{tenantId}/Issues(AssetModelId={assetModelId}, EntityId={entityId}) Get Issues single entity by assetmodelid, entityid and tenantid
IssuesApi issuesPatchByAssetmodelidAndEntityidAndTenantid PATCH /{region}/aim/2.0/{tenantId}/Issues(AssetModelId={AssetModelId}, EntityId={EntityId}) Patch Issues by assetmodelid, entityid and tenantid
IssuesApi issuesPostByTenantid POST /{region}/aim/2.0/{tenantId}/Issues Post a new entity to EntitySet Issues
JobsApi jobsAddDocumentByAssetmodelidAndEntityidAndTenantid POST /{region}/aim/2.0/{tenantId}/Jobs(AssetModelId={assetModelId}, EntityId={entityId})/DocumentEntities Adds a new document to a model entity
JobsApi jobsAsOfByDateAndTenantid GET /{region}/aim/2.0/{tenantId}/Jobs/AsOf(date={date}) Get Jobs as of by date and tenantid
JobsApi jobsGetAvailablePropertiesByAssetidAndTenantid GET /{region}/aim/2.0/{tenantId}/Jobs/GetAvailableProperties(assetId={assetId}) Gets the Properties available on this Model
JobsApi jobsGetByTenantid GET /{region}/aim/2.0/{tenantId}/Jobs Returns the EntitySet Jobs
JobsApi jobsGetSingleEntityByAssetmodelidAndEntityidAndTenantid GET /{region}/aim/2.0/{tenantId}/Jobs(AssetModelId={assetModelId}, EntityId={entityId}) Get Jobs single entity by assetmodelid, entityid and tenantid
JobsApi jobsPatchByAssetmodelidAndEntityidAndTenantid PATCH /{region}/aim/2.0/{tenantId}/Jobs(AssetModelId={AssetModelId}, EntityId={EntityId}) Patch Jobs by assetmodelid, entityid and tenantid
JobsApi jobsPostByTenantid POST /{region}/aim/2.0/{tenantId}/Jobs Post a new entity to EntitySet Jobs
LevelsApi levelsAddDocumentByAssetmodelidAndEntityidAndTenantid POST /{region}/aim/2.0/{tenantId}/Levels(AssetModelId={assetModelId}, EntityId={entityId})/DocumentEntities Adds a new document to a model entity
LevelsApi levelsAsOfByDateAndTenantid GET /{region}/aim/2.0/{tenantId}/Levels/AsOf(date={date}) Get Levels as of by date and tenantid
LevelsApi levelsGetAvailablePropertiesByAssetidAndTenantid GET /{region}/aim/2.0/{tenantId}/Levels/GetAvailableProperties(assetId={assetId}) Gets the Properties available on this Model
LevelsApi levelsGetByTenantid GET /{region}/aim/2.0/{tenantId}/Levels Returns the EntitySet Levels
LevelsApi levelsGetSingleEntityByAssetmodelidAndEntityidAndTenantid GET /{region}/aim/2.0/{tenantId}/Levels(AssetModelId={assetModelId}, EntityId={entityId}) Get Levels single entity by assetmodelid, entityid and tenantid
LevelsApi levelsPatchByAssetmodelidAndEntityidAndTenantid PATCH /{region}/aim/2.0/{tenantId}/Levels(AssetModelId={AssetModelId}, EntityId={EntityId}) Patch Levels by assetmodelid, entityid and tenantid
LevelsApi levelsPostByTenantid POST /{region}/aim/2.0/{tenantId}/Levels Post a new entity to EntitySet Levels
LogsApi logsIngestLogs POST /{region}/aim/2.0/logs/ImportJson Imports a batch of logs to the central logging service
ModelFilesApi modelFilesGetFile GET /{region}/aim/2.0/{tenantId}/modelfiles/download/{assetId}/{modelId} Downloads the model as originally uploaded
ModelFilesApi modelFilesUploadSingleFile 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
ModelMappingApi modelMappingGetByMappingidAndTenantid GET /{region}/aim/2.0/{tenantId}/ModelMapping({MappingId}) Get a single Mapping by its key
ModelMappingApi modelMappingGetByTenantid GET /{region}/aim/2.0/{tenantId}/ModelMapping Returns the EntitySet ModelMapping
ModelsApi modelsAssignByTenantidAndAssetmodelid POST /{region}/aim/2.0/{tenantId}/Models({AssetModelId})/Roles.Assign Assigns a user to the given role on the model
ModelsApi modelsDeleteByAssetmodelidAndTenantid DELETE /{region}/aim/2.0/{tenantId}/Models({AssetModelId}) Archive a model for future deletion
ModelsApi modelsGenerateModelMappingByAssetmodelidAndTargetmodelidAndTenantid POST /{region}/aim/2.0/{tenantId}/Models({AssetModelId})/GenerateModelMapping(id={targetModelId}) Generates a model mappings between two distinct models
ModelsApi modelsGetByTenantid GET /{region}/aim/2.0/{tenantId}/Models Returns the EntitySet Models
ModelsApi modelsGetSingleByAssetmodelidAndTenantid GET /{region}/aim/2.0/{tenantId}/Models({AssetModelId}) Returns the entity with the key from Models
ModelsApi modelsMemberAccessByAssetmodelidAndTenantid GET /{region}/aim/2.0/{tenantId}/Models({AssetModelId})/MemberAccess Gets the list of users with access to this model and their permissions
ModelsApi modelsMoveByTenantidAndAssetmodelid POST /{region}/aim/2.0/{tenantId}/Models({AssetModelId})/Asset.Move Move a model to another asset in this tenant
ModelsApi modelsPatchByAssetmodelidAndTenantid PATCH /{region}/aim/2.0/{tenantId}/Models({AssetModelId}) Edit an existing model
ModelsApi modelsPermissionsByAssetmodelidAndTenantid GET /{region}/aim/2.0/{tenantId}/Models({AssetModelId})/Permissions Gets the effective permissions for the current user
ModelsApi modelsPostByTenantid POST /{region}/aim/2.0/{tenantId}/Models Creates a new Model for the given Asset
ModelsApi modelsReprocessByAssetmodelidAndTenantid POST /{region}/aim/2.0/{tenantId}/Models({AssetModelId})/Reprocess() Requeues a model for processing and import
ModelsApi modelsRevokeByTenantidAndAssetmodelid POST /{region}/aim/2.0/{tenantId}/Models({AssetModelId})/Roles.Revoke Revokes a user from the given role on the model
ModelsApi modelsRolesByAssetmodelidAndTenantid GET /{region}/aim/2.0/{tenantId}/Models({AssetModelId})/Roles Gets the roles for the given Model
ModelsApi modelsSupercedeByKeyAndTenantid POST /{region}/aim/2.0/{tenantId}/Models({key})/Supercede() Supercede an existing model with a new version
ResourcesApi resourcesAddDocumentByAssetmodelidAndEntityidAndTenantid POST /{region}/aim/2.0/{tenantId}/Resources(AssetModelId={assetModelId}, EntityId={entityId})/DocumentEntities Adds a new document to a model entity
ResourcesApi resourcesAsOfByDateAndTenantid GET /{region}/aim/2.0/{tenantId}/Resources/AsOf(date={date}) Get Resources as of by date and tenantid
ResourcesApi resourcesGetAvailablePropertiesByAssetidAndTenantid GET /{region}/aim/2.0/{tenantId}/Resources/GetAvailableProperties(assetId={assetId}) Gets the Properties available on this Model
ResourcesApi resourcesGetByTenantid GET /{region}/aim/2.0/{tenantId}/Resources Returns the EntitySet Resources
ResourcesApi resourcesGetSingleEntityByAssetmodelidAndEntityidAndTenantid GET /{region}/aim/2.0/{tenantId}/Resources(AssetModelId={assetModelId}, EntityId={entityId}) Get Resources single entity by assetmodelid, entityid and tenantid
ResourcesApi resourcesPatchByAssetmodelidAndEntityidAndTenantid PATCH /{region}/aim/2.0/{tenantId}/Resources(AssetModelId={AssetModelId}, EntityId={EntityId}) Patch Resources by assetmodelid, entityid and tenantid
ResourcesApi resourcesPostByTenantid POST /{region}/aim/2.0/{tenantId}/Resources Post a new entity to EntitySet Resources
SchedulesApi schedulesGetScheduleByTenantid GET /{region}/aim/2.0/{tenantId}/Schedules({AssetModelId},{ScheduleName}) Get Schedules schedule by tenantid
SchedulesApi schedulesGetScheduleRowsByAssetmodelidAndSchedulenameAndTenantid GET /{region}/aim/2.0/{tenantId}/Schedules({assetModelId},'{scheduleName}')/Rows Get Schedules schedule rows by assetmodelid, schedulename and tenantid
SchedulesApi schedulesGetSchedulesByTenantid GET /{region}/aim/2.0/{tenantId}/Schedules Returns the EntitySet Schedules
SchedulesApi schedulesImportScheduleByModelidAndScheduleAndTenantid POST /{region}/aim/2.0/{tenantId}/Schedules/Import(AssetModelId={modelId},ScheduleName='{schedule}') Post Schedules import schedule by modelid, schedule and tenantid
SitesApi sitesAddDocumentByAssetmodelidAndEntityidAndTenantid POST /{region}/aim/2.0/{tenantId}/Sites(AssetModelId={assetModelId}, EntityId={entityId})/DocumentEntities Adds a new document to a model entity
SitesApi sitesAsOfByDateAndTenantid GET /{region}/aim/2.0/{tenantId}/Sites/AsOf(date={date}) Get Sites as of by date and tenantid
SitesApi sitesGetAvailablePropertiesByAssetidAndTenantid GET /{region}/aim/2.0/{tenantId}/Sites/GetAvailableProperties(assetId={assetId}) Gets the Properties available on this Model
SitesApi sitesGetByTenantid GET /{region}/aim/2.0/{tenantId}/Sites Returns the EntitySet Sites
SitesApi sitesGetSingleEntityByAssetmodelidAndEntityidAndTenantid GET /{region}/aim/2.0/{tenantId}/Sites(AssetModelId={assetModelId}, EntityId={entityId}) Get Sites single entity by assetmodelid, entityid and tenantid
SitesApi sitesPatchByAssetmodelidAndEntityidAndTenantid PATCH /{region}/aim/2.0/{tenantId}/Sites(AssetModelId={AssetModelId}, EntityId={EntityId}) Patch Sites by assetmodelid, entityid and tenantid
SitesApi sitesPostByTenantid POST /{region}/aim/2.0/{tenantId}/Sites Post a new entity to EntitySet Sites
SpacesApi spacesAddDocumentByAssetmodelidAndEntityidAndTenantid POST /{region}/aim/2.0/{tenantId}/Spaces(AssetModelId={assetModelId}, EntityId={entityId})/DocumentEntities Adds a new document to a model entity
SpacesApi spacesAsOfByDateAndTenantid GET /{region}/aim/2.0/{tenantId}/Spaces/AsOf(date={date}) Get Spaces as of by date and tenantid
SpacesApi spacesContainedComponentsByAssetmodelidAndEntityidAndTenantid 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
SpacesApi spacesGetAvailablePropertiesByAssetidAndTenantid GET /{region}/aim/2.0/{tenantId}/Spaces/GetAvailableProperties(assetId={assetId}) Gets the Properties available on this Model
SpacesApi spacesGetByTenantid GET /{region}/aim/2.0/{tenantId}/Spaces Returns the EntitySet Spaces
SpacesApi spacesGetSingleEntityByAssetmodelidAndEntityidAndTenantid GET /{region}/aim/2.0/{tenantId}/Spaces(AssetModelId={assetModelId}, EntityId={entityId}) Get Spaces single entity by assetmodelid, entityid and tenantid
SpacesApi spacesPatchByAssetmodelidAndEntityidAndTenantid PATCH /{region}/aim/2.0/{tenantId}/Spaces(AssetModelId={AssetModelId}, EntityId={EntityId}) Edit an existing space
SpacesApi spacesPostByTenantid POST /{region}/aim/2.0/{tenantId}/Spaces Adds a new Space to a model
SparesApi sparesAddDocumentByAssetmodelidAndEntityidAndTenantid POST /{region}/aim/2.0/{tenantId}/Spares(AssetModelId={assetModelId}, EntityId={entityId})/DocumentEntities Adds a new document to a model entity
SparesApi sparesAsOfByDateAndTenantid GET /{region}/aim/2.0/{tenantId}/Spares/AsOf(date={date}) Get Spares as of by date and tenantid
SparesApi sparesGetAvailablePropertiesByAssetidAndTenantid GET /{region}/aim/2.0/{tenantId}/Spares/GetAvailableProperties(assetId={assetId}) Gets the Properties available on this Model
SparesApi sparesGetByTenantid GET /{region}/aim/2.0/{tenantId}/Spares Returns the EntitySet Spares
SparesApi sparesGetSingleEntityByAssetmodelidAndEntityidAndTenantid GET /{region}/aim/2.0/{tenantId}/Spares(AssetModelId={assetModelId}, EntityId={entityId}) Get Spares single entity by assetmodelid, entityid and tenantid
SparesApi sparesPatchByAssetmodelidAndEntityidAndTenantid PATCH /{region}/aim/2.0/{tenantId}/Spares(AssetModelId={AssetModelId}, EntityId={EntityId}) Patch Spares by assetmodelid, entityid and tenantid
SparesApi sparesPostByTenantid POST /{region}/aim/2.0/{tenantId}/Spares Post a new entity to EntitySet Spares
StatsApi statsMeteredResources GET /{region}/aim/2.0/{tenantId}/stats/planAllowances Lists the plan allowances and current consumpttion for a tenant's app
StatsApi statsRateLimits GET /{region}/aim/2.0/{tenantId}/stats/rateLimits Provides details of the permitted rate limits for tenant's app and user
SystemsApi systemsAddDocumentByAssetmodelidAndEntityidAndTenantid POST /{region}/aim/2.0/{tenantId}/Systems(AssetModelId={assetModelId}, EntityId={entityId})/DocumentEntities Adds a new document to a model entity
SystemsApi systemsAsOfByDateAndTenantid GET /{region}/aim/2.0/{tenantId}/Systems/AsOf(date={date}) Get Systems as of by date and tenantid
SystemsApi systemsGetAvailablePropertiesByAssetidAndTenantid GET /{region}/aim/2.0/{tenantId}/Systems/GetAvailableProperties(assetId={assetId}) Gets the Properties available on this Model
SystemsApi systemsGetByTenantid GET /{region}/aim/2.0/{tenantId}/Systems Returns the EntitySet Systems
SystemsApi systemsGetSingleEntityByAssetmodelidAndEntityidAndTenantid GET /{region}/aim/2.0/{tenantId}/Systems(AssetModelId={assetModelId}, EntityId={entityId}) Get Systems single entity by assetmodelid, entityid and tenantid
SystemsApi systemsPatchByAssetmodelidAndEntityidAndTenantid PATCH /{region}/aim/2.0/{tenantId}/Systems(AssetModelId={AssetModelId}, EntityId={EntityId}) Patch Systems by assetmodelid, entityid and tenantid
SystemsApi systemsPostByTenantid POST /{region}/aim/2.0/{tenantId}/Systems Post a new entity to EntitySet Systems
ThumbnailsApi thumbnailsGetAssetThumbnail GET /{region}/aim/2.0/{tenantId}/thumbnails/asset/{assetId} Get Thumbnails asset thumbnail
ThumbnailsApi thumbnailsPostAssetThumbnail POST /{region}/aim/2.0/{tenantId}/thumbnails/asset/{assetId} Post Thumbnails asset thumbnail
WexbimApi wexbimGetComplete GET /{region}/aim/2.0/{tenantId}/wexbim/complete Gets the pre-generated complete wexbim geometry stream for a model
WexbimApi wexbimGetComponents GET /{region}/aim/2.0/{tenantId}/wexbim/components Gets the pre-generated components wexbim geometry stream for a model
WexbimApi wexbimGetDynamic GET /{region}/aim/2.0/{tenantId}/wexbim/dynamic Gets a dynamically generated geometry stream for a model
WexbimApi wexbimGetEnvelope GET /{region}/aim/2.0/{tenantId}/wexbim/envelope Gets the pre-generated building envelope wexbim geometry stream for a model
WexbimApi wexbimGetEnvelopeCut 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.
WexbimApi wexbimGetEnvelopeFreeCut GET /{region}/aim/2.0/{tenantId}/wexbim/envelopefreecut Gets the a cutplane across the envelope for up to 6 cut planes.
WexbimApi wexbimGetSite GET /{region}/aim/2.0/{tenantId}/wexbim/site Gets the pre-generated Site wexbim geometry stream for a model
WexbimApi wexbimGetSpatialStructure GET /{region}/aim/2.0/{tenantId}/wexbim/spatial Gets the pre-generated spatial wexbim geometry stream for a model
WexbimApi wexbimGetWindowsAndDoors GET /{region}/aim/2.0/{tenantId}/wexbim/windowsdoors Gets the pre-generated doors/windows wexbim geometry stream for a model
ZonesApi zonesAddDocumentByAssetmodelidAndEntityidAndTenantid POST /{region}/aim/2.0/{tenantId}/Zones(AssetModelId={assetModelId}, EntityId={entityId})/DocumentEntities Adds a new document to a model entity
ZonesApi zonesAsOfByDateAndTenantid GET /{region}/aim/2.0/{tenantId}/Zones/AsOf(date={date}) Get Zones as of by date and tenantid
ZonesApi zonesGetAvailablePropertiesByAssetidAndTenantid GET /{region}/aim/2.0/{tenantId}/Zones/GetAvailableProperties(assetId={assetId}) Gets the Properties available on this Model
ZonesApi zonesGetByTenantid GET /{region}/aim/2.0/{tenantId}/Zones Returns the EntitySet Zones
ZonesApi zonesGetSingleEntityByAssetmodelidAndEntityidAndTenantid GET /{region}/aim/2.0/{tenantId}/Zones(AssetModelId={assetModelId}, EntityId={entityId}) Get Zones single entity by assetmodelid, entityid and tenantid
ZonesApi zonesPatchByAssetmodelidAndEntityidAndTenantid PATCH /{region}/aim/2.0/{tenantId}/Zones(AssetModelId={AssetModelId}, EntityId={EntityId}) Patch Zones by assetmodelid, entityid and tenantid
ZonesApi zonesPostByTenantid POST /{region}/aim/2.0/{tenantId}/Zones Post a new entity to EntitySet Zones

Documentation For Models

Documentation For Authorization

oauth2

Author

info@xbim.net

Libraries

api