Jump to Content
Home
Guides
API Reference
Discussions
v1.0
v2.0
Log In
API Reference
Log In
Flex API
Home
Guides
API Reference
Discussions
Post webhook
Search
JUMP TO
Flex Identity 2.0
Me
My account
get
My regions
get
My regions
get
Tenants
List items
get
Create tenant
post
Show tenant
get
Update tenant
patch
Delete tenant
delete
List subscriptions
get
Patch Subscription
patch
Access demo
get
Get demo tenant
get
Lookup tenant
get
Check identifier
get
Members
List members
get
Create Member
post
Show member
get
Update Member
patch
Revoke member
delete
Users
List Users
get
Create User
post
Update User
put
Show User
get
Lookup user
get
Invitations
List invitations
get
Create invitation
post
Show invitation
get
Update invitation
patch
Despatch invitation
post
Revoke invitation
post
Registration
Accept invitation
post
Gets 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.
get
ClientApplications
List items
get
Show client application
get
List endpoints
get
Create endpoint
post
Masters
List items
get
Get Masters by masterId
get
Post AddMasterAdministrator
post
Delete RemoveMasterAdministrator
delete
PaymentWebhook
Post webhook
post
Subscriptions
Get Subscriptions
get
Post Subscriptions
post
Get Subscriptions by subscriptionId
get
Patch Subscriptions
patch
Delete Subscriptions
delete
Portal
Post portal
post
Payment
Post checkout
post
Get plan by tenantId
get
Authentication
Get token
post
Flex AIM 2.0
Assets
Returns the EntitySet Assets
get
Post a new entity to EntitySet Assets
post
Returns the entity with the key from Assets
get
Archive an Asset and and models for future deletion
delete
Edit an existing asset
patch
create new role for the given Asset
post
Gets the list of users with access to this item and their permissions
get
Gets the effective permissions for this current user
get
Gets the roles for the given Asset
get
Assigns a user to the given role on the asset
post
Revokes a user from the given role on the asset
post
Models
Returns the EntitySet Models
get
Creates a new Model for the given Asset
post
Returns the entity with the key from Models
get
Archive a model for future deletion
delete
Edit an existing model
patch
Move a model to another asset in this tenant
post
Assigns a user to the given role on the model
post
Generates a model mappings between two distinct models
post
Gets the list of users with access to this model and their permissions
get
Gets the effective permissions for the current user
get
Requeues a model for processing and import
post
Gets the roles for the given Model
get
Revokes a user from the given role on the model
post
Supercede an existing model with a new version
post
ModelFiles
Downloads the model as originally uploaded
get
A one-stop service for Uploading an IFC model file, creating an asset and Model as required, and initiating processing
post
Contacts
Returns the EntitySet Contacts
get
Post a new entity to EntitySet Contacts
post
Get Contacts single entity by assetmodelid, entityid and tenantid
get
Patch Contacts by assetmodelid, entityid and tenantid
patch
Adds a new document to an entity
post
Get Contacts as of by date and tenantid
get
Gets the Properties available on this Model
get
Sites
Returns the EntitySet Sites
get
Post a new entity to EntitySet Sites
post
Get Sites single entity by assetmodelid, entityid and tenantid
get
Patch Sites by assetmodelid, entityid and tenantid
patch
Adds a new document to an entity
post
Get Sites as of by date and tenantid
get
Gets the Properties available on this Model
get
Facilities
Returns the EntitySet Facilities
get
Post a new entity to EntitySet Facilities
post
Get Facilities single entity by assetmodelid, entityid and tenantid
get
Patch Facilities by assetmodelid, entityid and tenantid
patch
Adds a new document to an entity
post
Get Facilities as of by date and tenantid
get
Gets the Properties available on this Model
get
Levels
Returns the EntitySet Levels
get
Post a new entity to EntitySet Levels
post
Gets the Floorplan for this level
get
Get Levels single entity by assetmodelid, entityid and tenantid
get
Patch Levels by assetmodelid, entityid and tenantid
patch
Adds a new document to an entity
post
Get Levels as of by date and tenantid
get
Gets the Properties available on this Model
get
Spaces
Returns the EntitySet Spaces
get
Adds a new Space to a model
post
Gets the Floorplan for this space
get
Edit an existing space
patch
Get Spaces single entity by assetmodelid, entityid and tenantid
get
Gets the set of Components which are placed within the Geometry footprint of this Space
get
Adds a new document to an entity
post
Get Spaces as of by date and tenantid
get
Gets the Properties available on this Model
get
Zones
Returns the EntitySet Zones
get
Post a new entity to EntitySet Zones
post
Get Zones single entity by assetmodelid, entityid and tenantid
get
Patch Zones by assetmodelid, entityid and tenantid
patch
Adds a new document to an entity
post
Get Zones as of by date and tenantid
get
Gets the Properties available on this Model
get
ComponentTypes
Returns the EntitySet ComponentTypes
get
Post a new entity to EntitySet ComponentTypes
post
Get ComponentTypes single entity by assetmodelid, entityid and tenantid
get
Patch ComponentTypes by assetmodelid, entityid and tenantid
patch
Adds a new document to an entity
post
Get ComponentTypes as of by date and tenantid
get
Gets the Properties available on this Model
get
Components
Returns the EntitySet Components
get
Adds a new Component to a model
post
Edit an existing component
patch
Get Components single entity by assetmodelid, entityid and tenantid
get
Gets the Spaces this Component is placed in, based on Footprint data
get
Adds a new document to an entity
post
Get Components as of by date and tenantid
get
Gets the Properties available on this Model
get
Systems
Returns the EntitySet Systems
get
Post a new entity to EntitySet Systems
post
Get Systems single entity by assetmodelid, entityid and tenantid
get
Patch Systems by assetmodelid, entityid and tenantid
patch
Adds a new document to an entity
post
Get Systems as of by date and tenantid
get
Gets the Properties available on this Model
get
Assemblies
Returns the EntitySet Assemblies
get
Post a new entity to EntitySet Assemblies
post
Get Assemblies single entity by assetmodelid, entityid and tenantid
get
Patch Assemblies by assetmodelid, entityid and tenantid
patch
Adds a new document to an entity
post
Get Assemblies as of by date and tenantid
get
Gets the Properties available on this Model
get
Spares
Returns the EntitySet Spares
get
Post a new entity to EntitySet Spares
post
Get Spares single entity by assetmodelid, entityid and tenantid
get
Patch Spares by assetmodelid, entityid and tenantid
patch
Adds a new document to an entity
post
Get Spares as of by date and tenantid
get
Gets the Properties available on this Model
get
Resources
Returns the EntitySet Resources
get
Post a new entity to EntitySet Resources
post
Get Resources single entity by assetmodelid, entityid and tenantid
get
Patch Resources by assetmodelid, entityid and tenantid
patch
Adds a new document to an entity
post
Get Resources as of by date and tenantid
get
Gets the Properties available on this Model
get
Jobs
Returns the EntitySet Jobs
get
Post a new entity to EntitySet Jobs
post
Get Jobs single entity by assetmodelid, entityid and tenantid
get
Patch Jobs by assetmodelid, entityid and tenantid
patch
Adds a new document to an entity
post
Get Jobs as of by date and tenantid
get
Gets the Properties available on this Model
get
Issues
Returns the EntitySet Issues
get
Post a new entity to EntitySet Issues
post
Get Issues single entity by assetmodelid, entityid and tenantid
get
Patch Issues by assetmodelid, entityid and tenantid
patch
Adds a new document to an entity
post
Get Issues as of by date and tenantid
get
Gets the Properties available on this Model
get
Documents
Returns the EntitySet Documents
get
Post a new entity to EntitySet Documents
post
Get Documents single entity by assetmodelid, entityid and tenantid
get
Patch Documents by assetmodelid, entityid and tenantid
patch
Adds a new document to an entity
post
Get Documents as of by date and tenantid
get
Gets the Properties available on this Model
get
DocumentFiles
Downloads binary file related to asset and model
get
Uploads a document file related to a specific model
post
Entities
Returns the EntitySet Entities
get
Post a new entity to EntitySet Entities
post
Provides the xbim flex identities for a set of provided IfcGuids
post
Get Entities single entity by assetmodelid, entityid and tenantid
get
Patch Entities by assetmodelid, entityid and tenantid
patch
Adds a new document to an entity
post
Get Entities as of by date and tenantid
get
Query a set of Entities at a point in time
get
Gets the Properties available on this Model
get
Applications
Returns the entity with the key from Applications
get
Returns the EntitySet Applications
get
Attributes
Returns the EntitySet Attributes
get
Creates a new AttributeDefinition for a model
post
Operation to interrogate a single attribute definition
get
Update an AttributeDefinition for a model
patch
Change the underlying data type for the attribute, migrating any existing data where possible
post
Gets a sample of the attribute values for the definition
get
Imports attribute values from the source model file
post
Gets the unimported attribute values for an entity from the source model
get
Gets the unimported attribute values for an entity from the source model
get
AttributeValues
Returns the EntitySet AttributeValues
get
Schedules
Returns the EntitySet Schedules
get
Get Schedules schedule by assetmodelid, schedulename and tenantid
get
Get Schedules schedule rows by assetmodelid, schedulename and tenantid
get
Post Schedules import schedule by modelid, schedule and tenantid
post
Wexbim
Gets the pre-generated complete wexbim geometry stream for a model
get
Gets the pre-generated components wexbim geometry stream for a model
get
Gets a dynamically generated geometry stream for a model
get
Gets the pre-generated building envelope wexbim geometry stream for a model
get
Gets the building envelope geometry cut plane. This can be used to cap the holes after clipping.
get
Gets the a cutplane across the envelope for up to 6 cut planes.
get
Gets the pre-generated Site wexbim geometry stream for a model
get
Gets the pre-generated spatial wexbim geometry stream for a model
get
Gets the pre-generated doors/windows wexbim geometry stream for a model
get
Floorplans
Get Floor plan
post
Get Room plan
post
Thumbnails
Get Thumbnails asset thumbnail
get
Post Thumbnails asset thumbnail
post
ModelMapping
Returns the EntitySet ModelMapping
get
Get a single Mapping by its key
get
Get the set of Candidate Matches belonging to a Map
get
Get the set of Found Entities belonging to a Map
get
Get the set of Lost Entities belonging to a Map
get
Get the set of Mapped Entities belonging to a Map
get
Stats
Lists the plan allowances and current consumpttion for a tenant's app
get
Diagnostics
Returns the EntitySet Diagnostics
get
Logs
Imports a batch of logs to the central logging service
post
Admin
Lists the Database schema updates already installed
get
Flushes the Flex caches
post
Returns a flag indicating if the database schema requires an upgrade
get
Lists the Database schema updates required
get
Updates the Database schemas to the latest version
post
Invitation
Updates the users permissions after an invite has been accepted
put
Flex Comms 2.0
Contacts
Get Contacts
get
Get Contacts search
get
Conversations
Get Conversations
get
Post Conversations conversation
post
Get Conversations public
get
Get Conversations public
get
Aggregates conversation data efficiently for reporting purposes
get
Get Conversations by id
get
Delete Conversations conversation
delete
Patch Conversations conversation
patch
Imports a BCF File's Topics and Markup as one or more Flex conversations
post
Imports a BCF File's Topics and Markup as a single Flex conversation
post
Imports a BCF File as a single Flex conversation with one message containing all the content
post
Get Conversations demo conversation
get
Get Conversations clone conversation
get
Get Conversations send clone conversation
get
Delete Conversations participant
delete
Patch Conversations participant
patch
Get Conversations participiants
get
Put Conversations participants
put
Post Conversations participant
post
Get Conversations messages
get
Post Conversations message
post
Get Conversations message by id
get
Delete Conversations message
delete
Patch Conversations message
patch
Post Conversations send message
post
Put Conversations set message state
put
Get Conversations file
get
Delete Conversations file
delete
Get Conversations files
get
Post Conversations file
post
Put Conversations message part
put
Post Conversations swap message parts
post
Post Conversations mode message part
post
Delete Conversations message part
delete
Post Conversations insert message part
post
Files
Gets a File Blob from a Message
get
Snapshots
Gets a File Blob from a Message
get
ValidationResults
Gets a the validation results in a conversation by its file Id
get
Flex Workflows
Artifacts
Get Artifacts list
get
Get Artifacts download artifact
get
CleanPastInstances
Post CleanPastInstances
post
FlowTemplates
Get FlowTemplates list
get
Post FlowTemplates create flow template
post
Get FlowTemplates flow template
get
Delete FlowTemplates flow template
delete
Post FlowTemplates edit flow template
post
Post FlowTemplates add flow template dependency
post
Delete FlowTemplates remove flow template dependency
delete
Put FlowTemplates upload flow template resources
put
Get FlowTemplates list flow template resources
get
Delete FlowTemplates flow template resources
delete
Put FlowTemplates upload flow template thumbnail
put
Get FlowTemplates flow template thumbnail
get
Delete FlowTemplates flow template thumbnail
delete
Get FlowTemplates flow template resource
get
Delete FlowTemplates flow template resource
delete
Post FlowTemplates create workflow from template
post
Health
Get Health status
get
Instances
Get Instances instance
get
Get Instances list
get
Get Instances list pipeline
get
Post Instances rerun pipeline instance
post
Get Instances instance result actions
get
Delete Instances instance files
delete
Patch Instances cancel instance
patch
Get Instances instance step log
get
Operations
Post Operations get allowed
post
Pipelines
Get Pipelines list pipeline templates
get
Post Pipelines create pipeline template
post
Get Pipelines pipeline template
get
Delete Pipelines pipeline template
delete
Post Pipelines clone workflow
post
Post Pipelines edit workflow
post
Put Pipelines upload pipeline template files
put
Get Pipelines list pipeline template files
get
Get Pipelines pipeline template file
get
Delete Pipelines template pipeline file
delete
Get Pipelines list tenant pipeline templates
get
Resources
Get Resources list instance
get
Get Resources download instance resource
get
ServiceConnections
Post ServiceConnections create service connection
post
Get ServiceConnections
get
Get ServiceConnections service connection by id
get
Get ServiceConnections service connection by name
get
Delete ServiceConnections service connection
delete
Post ServiceConnections edit service connection
post
Stats
Get Stats instances pass rate
get
Get Stats instances failures
get
Get Stats executions per day
get
Get Stats executions per month
get
Get Stats total executions
get
Get Stats workflows count
get
Triggers
Post Triggers create staging instance
post
Put Triggers upload to staging instance
put
Put Triggers execute staging instance
put
Put Triggers file drop trigger
put
Put Triggers aimtrigger
put
Put Triggers link drop trigger
put
Post Triggers create drop trigger
post
Post Triggers create aimtrigger
post
Get Triggers pipeline trigger
get
Get Triggers list pipeline
get
Delete Triggers pipeline trigger
delete
ValidationResults
Get ValidationResults list
get
Get ValidationResults
get
Get ValidationResults validation result
get
Flex IoT
MappingEntities
rs Retrieve all mapping entities for the specified tenant and asset. (Auth policies: IotRead)
get
Adds a new mapping entity for the specified tenant and asset. (Auth policies: IotWrite)
post
Retrieve a mapping entity by ID for the specified tenant and asset. (Auth policies: IotRead)
get
Deletes a mapping entity by ID for the specified tenant and asset. (Auth policies: IotWrite)
delete
Presentations
Retrieve all presentations for a specific tenant and asset. (Auth policies: IotRead)
get
Create a new presentation. (Auth policies: IotWrite)
post
Retrieve a specific presentation by ID. (Auth policies: IotRead)
get
Update a presentation. (Auth policies: IotWrite)
patch
Delete a presentation by its ID. (Auth policies: IotWrite)
delete
Remapping
(Auth policies: Admin)
put
Sensors
Retrieve all sensors for the specified asset. (Auth policies: IotRead)
get
Retrieve a specific sensor by its ID. (Auth policies: IotRead)
get
Updates sensor information. Limitation: Can't be used to nullify any property. (Auth policies: IotWrite)
patch
SensorTags
Retrieve all tags for a specific tenant and asset. (Auth policies: IotRead)
get
Create a new Sensor Tag. (Auth policies: IotWrite)
post
Delete a Tag by its ID. (Auth policies: IotWrite)
delete
Tags
Retrieve all tags for a specific tenant and asset. (Auth policies: IotRead)
get
Create a new Tag. (Auth policies: IotWrite)
post
Retrieve a specific Tag by ID. (Auth policies: IotRead)
get
Update a Tag. (Auth policies: IotWrite)
patch
Delete a Tag by its ID. (Auth policies: IotWrite)
delete
Units
Get all the unit definitions available to the current user in the current resource scope (Auth policies: IotRead)
get
Get conversion factor betwee two inits. These two units must have a common ancestor in the units definition hierarchy (conversion based units poin to Xbim.Flex.IOT.Services.Contracts.UnitDto.ConversionBaseUnit) (Auth policies: IotRead)
get
Powered by
Post webhook
post
https://apis.xbim-dev.net/id/2.0/payment-webhook
Summary:
Return Type:
Language
Shell
Node
Ruby
PHP
Python
RESPONSE
Click
Try It!
to start a request and see the response here!