Bimplus API Reference

Project Service

• Create a new project
• Create copy of the source project
• Get the logged in user's project list
• Get the user's project list from a team
• Get the properties of the project
• Update the project
• Create an issue in the project
• Get the issue list from the project
• Delete all the issues from the project
• Create a new attachment in the project
• Get the attachment list from the project
• Delete all the attachments from the project
• Get the project topology
• Get the project layers
• Get material surfaces of the project
• Get the spot list from the project
• Create / Upload a thumbnail to the project
• Download the thumbnail
• Get the structure list from the project
• Delete all the structures from the project
• Get the topology of all structures belonging to the project
• Delete the project

Model Service

• Create a new model
• Get the logged in user's model list
• Get the list of existing models inside a project
• Get the model details
• Get the list of discipines from the model
• Update the model
• Download the model
• Delete the model

Object Service

• Create a new object
• Get the object details
• Generate, save & share the view of an object
• Check whether an object has been updated (See only the header info)
• Get the full property list of the object without geometry
• Get the object tree with full property list without geometry (object topology tree)
• Get the optimized objects tree with selected property list whose geometry type is "ThreeJS"
• Get the object tree with full property list whose geometry type is "compressed geometry mesh (meshblob)"
• Get the object tree with selected property list whose geometry type is "ThreeJS" filtered by layer
• Get the object tree whose geometry type is "compressed geometry mesh (meshblob)" filtered by layer
• Get the different properties / structure(normal, viewer properties, object in hierarchical tree structure) of the object using different property combinations 
• Get the complex properties of the object  
• Update the object
• Create a new comment in the object
• Get all the comments of the object
• If there is not any attachment for selection/structure the return code is 404 Not Found. If Selection\Document Folder structure contains files with same names, the return code is 403 Forbidden.
• Get the attachment list from the object
• Delete all attachments from the object
• Create a new hyperlink for the object
• Get the hyperlink list from the object
• Delete the object
• Create a new custom table in the object
• Get all the custom tables of the object
• Delete all the custom tables from the object

Custom attribute Service

• Create a free attribute group
• Get all the free attribute groups 
• Get the info about a particular free attribute group
• Update a particular free attribute group
• Delete a particular free attribute group
• Create a free attribute under a particular attribute group or as stand-alone
• Get all the free attributes
• Get all the free attributes under a attribute group
• Get the info about a particular free attribute 
• Update a particular free attribute  
• Delete a particular free attribute
• Create a unit
• Get all the units
• Get a particular unit
• Update a particular unit
• Delete a particular unit

Revision Service

• Create a new revision or update/overwrite a model
• Get the list of revisions of a model
• Get the info about a revision
• Update a revision
• List of APIs for retrieving info from a particular resource (3D objects, attachments etc)
• Calculate revisions comparison of the model
• Get calculated comparison of revisions of the model

CustomTable Service

• Get details of the custom table
• Update the custom table
• Delete the custom table

Cross Section Service

• Create a new cross section definition
• Get details of the cross section definition
• Get all cross sections section definitions
• Update the cross section definition
• Delete the cross section definition

• Create a new cross section for cross section definition
• Get details of cross section
• Get all cross sections from cross section definition
• Update cross section for cross section definition
• Delete the cross section

Connection Service

• Create a new connection
• Get the connection details
• Update the connection
• Delete the connection

ElementType Service

• Get all the element types
• Get the element type properties
• Get the list of existing layers

Attachment Service

• Get attachment information
• Download the attachment
• Update the attachment
• Delete the attachment
• Filter for getting project-only attachments & attachments that belong to a particular attachment-type
• Create a new version of an attachment
• Get all the versions of an attachment
• Download a particular version
• Delete a particular version

Issue Service

• Get details of the issue
• Get all the issue types
• Get details of the issue type
• Create a new pin for the issue
• Get all the pins of the issue
• Delete all the pins from the issue
• Create a new comment for the issue
• Get all the comments of the issue
• Create a new attachment for the issue
• Get the attachment list from the issue
• Delete all the attachments from the issue
• Working with hyperlinks belonging to an issue
• Update the issue
• Delete the issue

Pin Service

• Get details of the pin
• Update the pin
• Delete the pin

BCF Service

• Import a BCF file into Bimplus topics
• Export all the topics inside a project into a BCF file 
• Export a single or a list of Topics inside a project into a BCF file 
• Use filters to determine what to export during the export of topics

Import Service

• Replace a model by importing SketchUp and IFC files

Export IFC Service

• Export model to IFC file
• Export selected elements to IFC file

Export To Excel Service

• Export all the Bimplus Topics inside a project into Excel
• Export the list of Bimplus Topics to Excel
• Export all the objects insie a project into Excel

Hyperlink Service

• Get details of the hyperlink
• Update the hyperlink
• Delete the hyperlink

Structure Service

• Create a new structure in a project
• Get the structure details
• Create a sub-node under the structure
• Get the structure topology
• Assign an object to the latest/last structure node
• Update the structure
• Delete the structure
• Download attachments of the structure

Clash Service

• Detect all the clashes in a project
• Detect clashes between disciplines & objects/topologies
• Calculate clashes in project using particular clash filter
• Get all clashes for given project and clash filter
  
  
• Create an clash filter in the project
• Get all clash filters for a project
• Get all clash filters for a team
• Get details of single clash filter
• Update the clash filter
• Delete the clash filter 

User Settings Service

• Create an user setting
• Get the list of pre-defined user settings
• Get info about a setting
• Update a setting
• Delete a setting

Slideshow Service

• Create a new slideshow
• Get the slideshow list from a project
• Delete all the slideshows from a project
• Get details of the slideshow
• Update the slideshow
• Delete the slideshow
• Create a new slide for a slideshow
• Get the slide list from a slideshow
• Get the details of a slide
• Update the details of a slide
• Delete a slide from a slideshow
• Create a thumbnail for a slideshow
• Download the thumbnail from a slideshow
• Create a thumbnail for a slide
• Download the thumbnail from a slide
• Working with attachments/comments/hyperlinks belonging to a slide

Comment Service

• Get details of the comment
• Update the comment

Lock Service

• Lock an object
• Lock object with different possibilities (eg: Whether the children should be locked etc)
• Check if an object is locked
• Remove the lock

Authorization Service

• Authorizes a user and returns a token for further API calls
• Get token information
• Request a cross token
• Cross authenticate by using cross token
• Revoke / Terminate the token

User Management Service

• Create a new user
• Get information about the user
• Update information about the user
• Delete the user
• Get information about the currently logged in user

Team Management Service

• Create a new team and its related database
• Get information about the team
• Update information about the team
• Delete the team
• Get the team list in which the current logged in user is a member of
• Get team account settings

Membership Management Service

• Add the user to the team
• Get the member list of the team
• Update information about the user in the team
• Delete the user from the team

Rights and Roles Service

• Create new project rights and roles template

• Get the list of existing project rights and roles templates

• Get the info about a particular project rights and roles template

• Update the project rights and roles template

• Delete the project rights and roles template

• Copy project rights and roles template from source to target project rights and roles template 
  
  

• Get all the available roles
• Get all the available rights
  
  
• Create a new role
• Get details of the role
• Update the role
• Delete the role
  
• Make a team member part of a project by assigning a role to him
• Get the project members along with their respective roles
• Update the project role of a team member
• Remove the user from the project

Share Service

• Share a resource ( e.g. document )

Messaging Service

• Create a new message for an user
• Get the message list of the current user
• Get information about a specified message
• Modify content of the dashboard message
• Delete the specified message
• Mark a browser message as "read"
• Mark a browser message as "unread"
• Mark an email message as "unread"
• Filter the messages
• Get all messages sent by given user to all single users
• Get all messages sent by given user to all groups

• Create a new messaging group
• Get all the messaging groups
• Get the messaging group details
• Delete the messaging group

Object Navigator(filter) Service

• Get the predefined filters that belongs to a projects & discipline
• Get the building objects/elements using the filter
• Create a new filter

Export Object Service

• Create a new export object
• Get the export object details
• Get all the export objects of the project
• Delete the export object

Selection Object Service

• Create a new selection object
• Get the selection object details
• Get all the selection objects of the project
• Delete the selection object

Catalog Service

• Create a new norm
• Get the norm list
• Get the norm details
• Delete the specified norm

• Create a new country
• Get the country list 
• Get the country details 
• Delete the specified country

• Get a list of catalog types
• Get the catalog type details

• Create a new catalog item
• Get the catalog item details

• Create a new catalog
• Get the catalog list 
• Get the catalog details 
• Update the specified catalog
• Get the catalog item list from the specified catalog 
• Delete the specified catalog

Bimplus Windows Explorer related Services

• Create a new objectview
• Get the list of target objects(objectviews) which will be populated in the "Object Navigator List"
• Get information about an "Object Navigator" item (objectview)
• Get the properties(column names) of the objectview
• Get the required objectview's details from input objectview list reference
• Delete the objectview
• Create a hierarchy
• Create a list of hierarchies
• Create a complete new structure hierarchy
• Get all the user hierarchies using the user & module information
• Get the details of a hierarchy
• Get details about a list of hierarchies
• Delete the hierarchy
• Delete the list of hierarchies
• Delete all the hierarchies filtered by additional info