JUMP TOXbim Flex Identity API 2.0ClientApplicationsList itemsgetShow client applicationgetList endpointsgetCreate endpointpostMastersList itemsgetPost AddMasterAdministratorpostDelete RemoveMasterAdministratordeleteMeMy accountgetMy regionsgetRegistrationAccept invitationpostGets an invitation but only if it is acceptable by the current user. This is mainly to be used by other APIs to check if the invitation can be propagated into their access controll levels.getTenantsList itemsgetCreate tenantpostShow tenantgetUpdate tenantpatchDelete tenantdeleteList subscriptionsgetAccess demogetGet demo tenantgetLookup tenantgetCheck identifiergetInvitationsList invitationsgetCreate invitationpostShow invitationgetUpdate invitationpatchDespatch invitationpostRevoke invitationpostMembersList membersgetCreate MemberpostShow membergetUpdate MemberpatchRevoke memberdeleteAuthenticationGet tokenpostUsersList UsersgetCreate UserpostUpdate UserputShow UsergetLookup usergetXBIM Flex API v2AssetsGet AssetsgetCreate AssetspostGet an AssetgetArchive an Asset and and models for future deletiondeleteEdit an existing assetpatchAssigns a user to the given role on the assetpostGets the list of users with access to this item and their permissionsgetGets the effective permissions for this current usergetGets the roles for the given AssetgetRevokes a user from the given role on the assetpostModelsGet ModelsgetCreate ModelpostGet a ModelgetArchive a model for future deletiondeleteEdit an existing modelpatchMove a model to another asset in this tenantpostAssigns a user to the given role on the modelpostGenerates a model mappings between two distinct modelspostGets the list of users with access to this model and their permissionsgetGets the effective permissions for the current usergetRequeues a model for processing and importpostGets the roles for the given ModelgetRevokes a user from the given role on the modelpostSupercede an existing model with a new versionpostModelFilesDownloads the model as originally uploadedgetA one-stop service for Uploading an IFC model file, creating an asset and Model as required, and initiating processingpostDocumentFilesDownloads binary file related to asset and modelgetUploads a document file related to a specific modelpostFloorplansGets floor plan as SVG image. Element of SVG have encoded identity allowing to implement custom interactions where more data can be retrieved from Flex APIpostGets space floor plan as SVG image. Element of SVG have encoded identity allowing to implement custom interactions where more data can be retrieved from Flex APIpostWexbimGets the pre-generated complete wexbim geometry stream for a modelgetGets the pre-generated components wexbim geometry stream for a modelgetGets a dynamically generated geometry stream for a modelgetGets the pre-generated building envelope wexbim geometry stream for a modelgetGets the building envelope geometry cut plane. This can be used to cap the holes after clipping.getGets the a cutplane across the envelope for up to 6 cut planes.getGets the pre-generated Site wexbim geometry stream for a modelgetGets the pre-generated spatial wexbim geometry stream for a modelgetGets the pre-generated doors/windows wexbim geometry stream for a modelgetThumbnailsGet Thumbnails asset thumbnailgetPost Thumbnails asset thumbnailpostApplicationsReturns the entity with the key from ApplicationsgetReturns the EntitySet ApplicationsgetAssembliesReturns the EntitySet AssembliesgetPost a new entity to EntitySet AssembliespostGet Assemblies single entity by assetmodelid, entityid and tenantidgetPatch Assemblies by assetmodelid, entityid and tenantidpatchAdds a new document to a model entitypostGet Assemblies as of by date and tenantidgetGets the Properties available on this ModelgetAttributesReturns the EntitySet AttributesgetCreates a new AttributeDefinition for a modelpostOperation to interrogate a single attribute definitiongetUpdate an AttributeDefinition for a modelpatchChange the underlying data type for the attribute, migrating any existing data where possiblepostGets a sample of the attribute values for the definitiongetImports attribute values from the source model filepostGets the unimported attribute values for an entity from the source modelgetComponentsGet ComponentsgetCreate a new ComponentpostEdit an existing componentpatchGet a ComponentgetGets the Spaces this Component is placed in, based on Footprint datagetAdds a new document to a model entitypostGet Components as of by date and tenantidgetGets the Properties available on this ModelgetComponentTypesReturns the EntitySet ComponentTypesgetPost a new entity to EntitySet ComponentTypespostGet ComponentTypes single entity by assetmodelid, entityid and tenantidgetPatch ComponentTypes by assetmodelid, entityid and tenantidpatchAdds a new document to a model entitypostGet ComponentTypes as of by date and tenantidgetGets the Properties available on this ModelgetContactsReturns the EntitySet ContactsgetPost a new entity to EntitySet ContactspostGet Contacts single entity by assetmodelid, entityid and tenantidgetPatch Contacts by assetmodelid, entityid and tenantidpatchAdds a new document to a model entitypostGet Contacts as of by date and tenantidgetGets the Properties available on this ModelgetDocumentsReturns the EntitySet DocumentsgetPost a new entity to EntitySet DocumentspostGet Documents single entity by assetmodelid, entityid and tenantidgetPatch Documents by assetmodelid, entityid and tenantidpatchAdds a new document to a model entitypostGet Documents as of by date and tenantidgetGets the Properties available on this ModelgetEntitiesReturns the EntitySet EntitiesgetPost a new entity to EntitySet EntitiespostProvides the xbim flex identities for a set of provided IfcGuidspostGet Entities single entity by assetmodelid, entityid and tenantidgetPatch Entities by assetmodelid, entityid and tenantidpatchAdds a new document to a model entitypostGet Entities as of by date and tenantidgetQuery a set of Entities at a point in timegetGets the Properties available on this ModelgetFacilitiesReturns the EntitySet FacilitiesgetPost a new entity to EntitySet FacilitiespostGet Facilities single entity by assetmodelid, entityid and tenantidgetPatch Facilities by assetmodelid, entityid and tenantidpatchAdds a new document to a model entitypostGet Facilities as of by date and tenantidgetGets the Properties available on this ModelgetIssuesReturns the EntitySet IssuesgetPost a new entity to EntitySet IssuespostGet Issues single entity by assetmodelid, entityid and tenantidgetPatch Issues by assetmodelid, entityid and tenantidpatchAdds a new document to a model entitypostGet Issues as of by date and tenantidgetGets the Properties available on this ModelgetJobsReturns the EntitySet JobsgetPost a new entity to EntitySet JobspostGet Jobs single entity by assetmodelid, entityid and tenantidgetPatch Jobs by assetmodelid, entityid and tenantidpatchAdds a new document to a model entitypostGet Jobs as of by date and tenantidgetGets the Properties available on this ModelgetLevelsReturns the EntitySet LevelsgetPost a new entity to EntitySet LevelspostGet Levels single entity by assetmodelid, entityid and tenantidgetPatch Levels by assetmodelid, entityid and tenantidpatchAdds a new document to a model entitypostGet Levels as of by date and tenantidgetGets the Properties available on this ModelgetModelMappingReturns the EntitySet ModelMappinggetGet a single Mapping by its keygetReturns the EntitySet ModelMappingInfogetResourcesReturns the EntitySet ResourcesgetPost a new entity to EntitySet ResourcespostGet Resources single entity by assetmodelid, entityid and tenantidgetPatch Resources by assetmodelid, entityid and tenantidpatchAdds a new document to a model entitypostGet Resources as of by date and tenantidgetGets the Properties available on this ModelgetSitesReturns the EntitySet SitesgetPost a new entity to EntitySet SitespostGet Sites single entity by assetmodelid, entityid and tenantidgetPatch Sites by assetmodelid, entityid and tenantidpatchAdds a new document to a model entitypostGet Sites as of by date and tenantidgetGets the Properties available on this ModelgetSpacesReturns the EntitySet SpacesgetAdds a new Space to a modelpostEdit an existing spacepatchGet Spaces single entity by assetmodelid, entityid and tenantidgetGets the set of Components which are placed within the Geometry footprint of this SpacegetAdds a new document to a model entitypostGet Spaces as of by date and tenantidgetGets the Properties available on this ModelgetSparesReturns the EntitySet SparesgetPost a new entity to EntitySet SparespostGet Spares single entity by assetmodelid, entityid and tenantidgetPatch Spares by assetmodelid, entityid and tenantidpatchAdds a new document to a model entitypostGet Spares as of by date and tenantidgetGets the Properties available on this ModelgetSystemsReturns the EntitySet SystemsgetPost a new entity to EntitySet SystemspostGet Systems single entity by assetmodelid, entityid and tenantidgetPatch Systems by assetmodelid, entityid and tenantidpatchAdds a new document to a model entitypostGet Systems as of by date and tenantidgetGets the Properties available on this ModelgetZonesReturns the EntitySet ZonesgetPost a new entity to EntitySet ZonespostGet Zones single entity by assetmodelid, entityid and tenantidgetPatch Zones by assetmodelid, entityid and tenantidpatchAdds a new document to a model entitypostGet Zones as of by date and tenantidgetGets the Properties available on this ModelgetSchedulesReturns the EntitySet SchedulesgetGet Schedules schedule by assetmodelid, schedulename and tenantidgetGet Schedules schedule rows by assetmodelid, schedulename and tenantidgetPost Schedules import schedule by modelid, schedule and tenantidpostLogsImports a batch of logs to the central logging servicepostStatsLists the plan allowances and current consumpttion for a tenant's appgetProvides details of the permitted rate limits for tenant's app and usergetAdminLists the Database schema updates already installedgetFlushes the Flex cachespostReturns a flag indicating if the database schema requires an upgradegetLists the Database schema updates requiredgetUpdates the Database schemas to the latest versionpostDiagnosticsReturns the EntitySet DiagnosticsgetFlex Comms API 2.0ContactsGet ContactsgetGet Contacts searchgetConversationsGet ConversationsgetPost Conversations conversationpostAggregates conversation data efficiently for reporting purposesgetGet Conversations by idgetDelete Conversations conversationdeletePatch Conversations conversationpatchImports a BCF File's Topics and Markup as one or more Flex conversationspostGet Conversations demo conversationgetGet Conversations clone conversationgetGet Conversations send clone conversationgetDelete Conversations participantdeletePatch Conversations participantpatchGet Conversations participiantsgetPut Conversations participantsputPost Conversations participantpostGet Conversations messagesgetPost Conversations messagepostGet Conversations message by idgetDelete Conversations messagedeletePatch Conversations messagepatchPost Conversations send messagepostPut Conversations set message stateputGet Conversations filegetDelete Conversations filedeleteGet Conversations filesgetPost Conversations filepostPut Conversations message partputPost Conversations swap message partspostPost Conversations mode message partpostDelete Conversations message partdeletePost Conversations insert message partpostFilesGets a File Blob from a MessagegetSnapshotsGets a File Blob from a MessagegetXbim Flex WorkflowsArtifactsGet Artifacts listgetGet Artifacts download artifactgetCleanPastInstancesPost CleanPastInstancespostFlowTemplatesPut FlowTemplates upload flow template thumbnailputGet FlowTemplates flow template thumbnailgetDelete FlowTemplates flow template thumbnaildeletePut FlowTemplates upload flow template resourcesputGet FlowTemplates list flow template resourcesgetDelete FlowTemplates flow template resourcesdeleteDelete FlowTemplates remove flow template dependencydeleteGet FlowTemplates listgetPost FlowTemplates create flow templatepostGet FlowTemplates flow template resourcegetDelete FlowTemplates flow template resourcedeleteGet FlowTemplates flow templategetDelete FlowTemplates flow templatedeletePost FlowTemplates edit flow templatepostPost FlowTemplates create workflow from templatepostPost FlowTemplates add flow template dependencypostHealthGet Health statusgetInstancesPost Instances rerun pipeline instancepostGet Instances list pipelinegetGet Instances listgetGet Instances instance step loggetGet Instances instance result actionsgetGet Instances instancegetDelete Instances instance filesdeletePatch Instances cancel instancepatchOperationsPost Operations get allowedpostPipelinesPut Pipelines upload pipeline template filesputGet Pipelines list pipeline template filesgetGet Pipelines list pipeline templatesgetPost Pipelines create pipeline templatepostGet Pipelines pipeline template filegetDelete Pipelines template pipeline filedeleteGet Pipelines pipeline templategetDelete Pipelines pipeline templatedeletePost Pipelines edit workflowpostPost Pipelines clone workflowpostServiceConnectionsGet ServiceConnectionsgetPost ServiceConnections create service connectionpostGet ServiceConnections service connection by namegetGet ServiceConnections service connection by idgetPost ServiceConnections edit service connectionpostDelete ServiceConnections service connectiondeleteStatsGet Stats workflows countgetGet Stats total executionsgetGet Stats instances pass rategetGet Stats instances failuresgetGet Stats executions per monthgetGet Stats executions per daygetTriggersGet Triggers list pipelinegetPut Triggers link drop triggerputGet Triggers pipeline triggergetPut Triggers file drop triggerputDelete Triggers pipeline triggerdeletePost Triggers create drop triggerpostPost Triggers create aimtriggerpostPut Triggers aimtriggerputValidationResultsGet ValidationResults listgetGet ValidationResultsgetGet ValidationResults validation resultgetPowered by Get an Assetget https://apis.xbim-dev.net/{region}/aim/2.0/{tenantId}/Assets({AssetId})Summary:Returns the entity with the key from Assets.Return Type: Asset
