Bimplus WebSDK version : 0.0.29
Table of Contents
- api
- applicationSettingsattachmentsattributeTemplatesauthorizeclashDetectioncommentscustomTableselementTypesexportServicefreeAttributeGroupsfreeAttributeshiddenCalculationhyperlinksimportServiceissues
- post
- get
- postPin
- getPins
- deletePins
- postComment
- getComments
- deleteComments
- postAttachment
- getAttachments
- deleteAttachments
- put
- delete
- getRights
- getIssueTypes
- importBcf
- updateImportBcf
- exportBcf
- exportExcel
- post
- get
- getInternal
- head
- getTopology
- getGeometryThreeJS
- getGeometryTemplatesThreeJS
- getGeometryCompressed
- getProperties
- put
- postComment
- getComments
- deleteComments
- postAttachment
- getAttachments
- deleteAttachments
- postHyperlink
- getHyperlinks
- deleteHyperlinks
- delete
- getAttributes
- post
- put
- get
- delete
- getModels
- postModel
- getMembers
- postMember
- putMember
- deleteMember
- getPins
- putProject
- postAttachment
- getAttachments
- deleteAttachments
- getTopology
- getSpots
- postThumbnail
- getThumbnail
- getComments
- getHyperlinks
- getIssues
- postSlideshow
- getSlideshows
- deleteSlideshows
- getProjectInfo
- postRevision
- getRevisionList
- getRevisionInfo
- putRevisionInfo
- getRevisionsComparisonResult
- compareRevisions
- postStructure
- postSubNode
- postAssignedObject
- attributeAssign
- deleteAssignedObject
- getStructure
- getTopology
- copyStructure
- putStructure
- reorderStructure
- deleteStructure
- deleteAllProjectStructures
- postVariantType
- getVariantType
- deleteVariantType
- copyElementsToVariant
- applicationSettingsattachmentsattributeTemplatesauthorizeclashDetectioncommentscustomTableselementTypesexportServicefreeAttributeGroupsfreeAttributeshiddenCalculationhyperlinksimportServiceissues
api
Parameters
config
json api config
applicationSettings
postSettings
post settings
Parameters
data
json settins data
Returns promise promise
getSettings
get settings
Parameters
settingId
string settings id - if not specified return all settings
Returns promise promise
putSettings
put settings
Parameters
Returns promise promise
deleteSettings
delete settings
Parameters
settingId
string settings id
Returns promise promise
attachments
get
get attachment
Parameters
id
string atachment id
Returns promise promise
download
download attachment
Parameters
Returns promise promise
put
put attachment
Parameters
Returns promise promise
post
post attachment
Parameters
id
[type] [description]data
[type] [description]uploadProgress
Returns promise promise
delete
delete attachment
Parameters
Returns promise promise
postVersion
post new version of the attachment
Parameters
id
[type] [description]data
[type] [description]uploadProgress
Returns promise promise
getAllVersions
get all attachment versions
Parameters
id
string atachment id
Returns promise promise
attributeTemplates
post
post attribute template
Parameters
data
json template data
Returns promise promise
get
get attribute template - if id is not specified return all attribute templates
Parameters
id
string template id
Returns promise promise
put
put attribute template
Parameters
Returns promise promise
delete
delete attribute template
Parameters
id
string template id
Returns promise promise
authorize
post
post authorization
Parameters
username
string user namepassword
password passwordapplicationId
string application id - Please contact Allplan company to obtain application id !
Returns promise promise
forgotPassword
forgot password
Parameters
data
json data
Returns promise promise
checkAccessToken
check access token validity
Parameters
data
json [description]
Returns promise promise
requestCrossToken
request cross token
Returns promise promise
clashDetection
detectAllClashes
detect all clashes
Parameters
data
json calculation data
Returns promise promise
detectDisciplinesClashes
detect disciplines clashes
Parameters
data
json calculation data
Returns promise promise
getFilters
get clash filters
Parameters
filterId
string filter id - if not specified return all filters
Returns promise promise
calculateClashes
calculate clashes
Parameters
data
json calculation data
Returns promise promise
getFilterResults
get filter results
Parameters
Returns promise promise
comments
get
get comments
Parameters
id
string comments id
Returns promise promise
delete
delete comment
Parameters
id
string comments id
Returns promise promise
put
put comment
Parameters
Returns promise promise
Returns [type] [description]
customTables
get
get custom tables
Parameters
Returns promise promise
elementTypes
get
get element types - if id is not specified it returns all element types
Parameters
id
string element type id
Returns promise promise
getDisciplines
get element type disciplines - if id is not specified it returns all disciplines for element types
Parameters
id
string discipline id
Returns promise promise
getAttributeTemplates
get attribute templates
Parameters
id
string element type idqueryParams
json query params e.g. { attributes : true, projectAttributeTemplate: projectAttributeTemplateId }
Returns promise promise
getTopology
get element types topology
Returns promise promise
getProjectTopology
get element types for project
Parameters
projectId
string project id
Returns promise promise
exportService
exportObjects
export objects
Parameters
Returns promise promise
exportModel
export modelId
Parameters
Returns promise promise
freeAttributeGroups
_getUrl
private helper function to get correct url based on content property
Parameters
content
boolean flag if it is content attribute group
Returns promise promise
post
post free attribute group
Parameters
Returns promise promise
get
get free attribute group
Parameters
freeAttributeGroupId
string free attribute group idcontent
boolean flag if it is content attribute group
Returns promise promise
put
put free attribute group
Parameters
freeAttributeGroupId
string free attribute group iddata
json group datacontent
boolean flag if it is content attribute group
Returns promise promise
delete
delete free attribute group
Parameters
freeAttributeGroupId
string free attribute group idcontent
boolean flag if it is content attribute group
Returns promise promise
getFreeAttributes
get free attribute group
Parameters
freeAttributeGroupId
string free attribute group idcontent
boolean flag if it is content attribute group
Returns promise promise
freeAttributes
_getUrl
private helper function to get correct url based on content property
Parameters
content
boolean flag if it is content attribute
Returns promise promise
post
post free attribute
Parameters
Returns promise promise
get
get free attribute - if freeAttributeId is not specified return all
Parameters
freeAttributeId
string attribute idcontent
boolean flag if it is content attributequeryParams
string filter query
Returns promise promise
put
put free attribute
Parameters
freeAttributeId
string attribute iddata
json attribute datacontent
boolean flag if it is content attribute
Returns promise promise
delete
delete free attribute
Parameters
Returns promise promise
getTopology
get free attribute topology
Parameters
content
boolean flag if it is content attribute
Returns promise promise
getFilteredAttributes
get filtered attributes
Parameters
projectId
string project idlayerId
string for filtering attributes from requested disciplinetype
string for filtering attributes from special objects like 'Tasks', 'Attachments', 'Structures'
Returns promise promise
hiddenCalculation
calculate
calculate hidden
Parameters
projectId
string project idview
json view paramsfilename
string file nameasync
boolean run async flag
Returns promise promise
hyperlinks
get
get hyperlink
Parameters
id
string hyperlink id
Returns promise promise
delete
delete hyperlink
Parameters
id
string hyperlink id
Returns promise promise
put
put hyperlink
Parameters
Returns promise promise
importService
postModel
post model
Parameters
Returns promise promise
issues
post
post issue
Parameters
Returns promise promise
get
get issue
Parameters
id
string issue id
Returns promise promise
postPin
post issue's pin
Parameters
Returns promise promise
getPins
get issue's pins
Parameters
id
string issue id
Returns promise promise
deletePins
delete issues pins
Parameters
id
string issue id
Returns promise promise
postComment
post issue's comment
Parameters
Returns promise promise
getComments
get issues comments
Parameters
id
string issue id
Returns promise promise
deleteComments
delete issue's comments
Parameters
id
string issue id
Returns promise promise
postAttachment
post issue's attachment
Parameters
Returns promise promise
getAttachments
get issue's attachment
Parameters
id
string issue id
Returns promise promise
deleteAttachments
delete issue's attachment
Parameters
id
string issue id
Returns promise promise
put
put issue
Parameters
Returns promise promise
delete
delete issue
Parameters
id
string issue id
Returns promise promise
getRights
get issue rights
Parameters
id
string issue id
Returns promise promise
getIssueTypes
get issue types
Returns promise promise
importBcf
import issue from bcf
Parameters
Returns promise promise
updateImportBcf
update import bcf
Parameters
Returns promise promise
exportBcf
export issues in bcf format
Parameters
Returns promise promise
exportExcel
export issue in excel format
Parameters
Returns promise promise
locks
lockObject
lock object
Parameters
Returns promise promise
checkLocked
check if object is locked
Parameters
objectId
string object id
Returns promise promise
deleteLock
delete object lock
Parameters
objectId
string object id
Returns promise promise
members
post
post member
Parameters
data
json member data
Returns promise promise
get
get team members
Returns promise promise
putUser
put user
Parameters
Returns promise promise
deleteUser
delete user
Parameters
Returns promise promise
messages
post
post message
Parameters
data
json message data
Returns promise promise
getUserMessages
get user messages
Parameters
userId
string user id
Returns promise promise
get
get message
Parameters
messageId
string message id
Returns promise promise
getFiltered
get filtered messages
Parameters
filter
string filter
Returns promise promise
deleteMessage
delete message
Parameters
messageId
string message id
Returns promise promise
markAsRead
mark message as readed
Parameters
messageId
string message id
Returns promise promise
models
get
get model
Parameters
modelId
string model id
Returns promise promise
head
get head
Parameters
modelId
string model id
Returns [type] [description]
Returns promise promise
getDisciplines
get disciplines
Parameters
divisionId
string division id
Returns promise promise
getRevisions
get revisions
Parameters
divisionId
string division id
Returns promise promise
postRevision
post revision
Parameters
Returns promise promise
put
put model
Parameters
Returns promise promise
download
download model
Parameters
divisionId
string division id
Returns promise promise
delete
delete model
Parameters
divisionId
string division id
Returns promise promise
move
move model
Parameters
divisionId
string division idmoveData
json move data e.g. { deltax:delta.x,deltay:delta.y,delta_z:delta.z }
Returns promise promise
objectFilters
get
get object filters
Parameters
Returns promise promise
getFilteredObjects
get filtered objects
Parameters
Returns promise promise
applyFilter
apply filter
Parameters
filterId
string filter id
Returns promise promise
post
post object filter
Parameters
data
json object filter data
Returns promise promise
put
put object filter
Parameters
data
json object filter data
Returns promise promise
delete
delete object filter
Parameters
id
string object filter id
Returns promise promise
objects
post
post object
Parameters
data
json data
Returns promise promise
get
get object
Parameters
Returns promise promise
getInternal
get internal
Parameters
Returns promise promise
head
get head
Parameters
Returns promise promise
getTopology
get object topology
Parameters
Returns promise promise
getGeometryThreeJS
get object geometry in three js format
Parameters
objectId
string object iddisciplineId
string discipline idchunked
boolean chunked flagrevision
number revision numberlod
string level of detailproperties
string properties
Returns promise promise
getGeometryTemplatesThreeJS
get geometry templates in three js format
Parameters
objectId
string object iddisciplineId
string discipline idchunked
boolean chunked flagrevision
number revision numberlod
string level of detail
Returns promise promise
getGeometryCompressed
get object compressed geometry
Parameters
Returns promise promise
getProperties
get object properties
Parameters
Returns promise promise
put
get object data
Parameters
Returns promise promise
postComment
post comment
Parameters
Returns promise promise
getComments
get object comments
Parameters
objectId
string object id
Returns promise promise
deleteComments
delete object comments
Parameters
objectId
string object id
Returns promise promise
postAttachment
post object attachemnt
Parameters
Returns promise promise
getAttachments
get object attachments
Parameters
Returns promise promise
deleteAttachments
delete all object's attachment
Parameters
objectId
string object id
Returns promise promise
postHyperlink
post object hyperlink
Parameters
Returns promise promise
getHyperlinks
get object hyperlinks
Parameters
objectId
string object id
Returns promise promise
deleteHyperlinks
delete all object's hyperlinks
Parameters
objectId
string object id
Returns promise promise
delete
delete object
Parameters
objectId
string object id
Returns promise promise
getAttributes
get object attributes
Parameters
Returns promise promise
pins
get
get pins
Parameters
id
string pin id
Returns promise promise
delete
delete pin
Parameters
id
string pin id
Returns promise promise
put
put pin
Parameters
Returns promise promise
projectActionsRights
get
get project action rights
Parameters
id
any currently not used
Returns promise promise
projectAttributeTemplates
post
post project attribute template
Parameters
data
json template data
Returns promise promise
get
get project attribute template - if id is not specified return all templates
Parameters
id
string template id
Returns promise promise
put
put project template attribute
Parameters
Returns promise promise
delete
delete project template attribute
Parameters
id
string template id
Returns promise promise
copyFrom
copy project template attribute
Parameters
Returns promise promise
projects
post
post project
Parameters
data
json project data
Returns promise promise
put
put project
Parameters
Returns promise promise
get
get project - if no id is specified return list of all projects
Parameters
Returns promise [description]
delete
delete project
Parameters
projectId
string project id
Returns promise [description]
getModels
get project's models
Parameters
projectId
string project id
Returns promise [description]
postModel
post model
Parameters
Returns promise [description]
getMembers
get project members
Parameters
projectId
string project id
Returns promise [description]
postMember
post member
Parameters
Returns promise [description]
putMember
put member
Parameters
Returns promise [description]
deleteMember
delete member
Parameters
Returns promise [description]
getPins
get project pins
Parameters
projectId
string project id
Returns promise [description]
putProject
put project
Parameters
Returns promise [description]
postAttachment
post attachment
Parameters
Returns promise [description]
getAttachments
get attachments
Parameters
projectId
string project idrevision
number revision numberqueryParams
json json with params e.g. {projectOnly : true}
Returns promise [description]
deleteAttachments
delete attachment
Parameters
projectId
string project id
Returns promise [description]
getTopology
get project's topology
Parameters
projectId
string project id
Returns promise [description]
getSpots
get spots
Parameters
projectId
string project id
Returns promise [description]
postThumbnail
post thumbnail
Parameters
Returns promise [description]
getThumbnail
get thumbnail
Parameters
thumbnailId
string thumbnail id
Returns promise [description]
getComments
get comments
Parameters
projectId
string project id
Returns promise [description]
getHyperlinks
get hyperlinks
Parameters
projectId
string project id
Returns promise [description]
getIssues
get issues (tasks)
Parameters
projectId
string project id
Returns promise [description]
postSlideshow
post slideshow
Parameters
Returns promise [description]
getSlideshows
get slideshows
Parameters
projectId
string project id
Returns promise [description]
deleteSlideshows
delete slideshows
Parameters
projectId
string project id
Returns promise [description]
getProjectInfo
get project info
Parameters
projectId
string project id
Returns promise promise
revisions
postRevision
post revision
Parameters
Returns promise promise
getRevisionList
get revisions list
Parameters
id
string division (model) id
Returns promise promise
getRevisionInfo
get revision info
Parameters
id
string revision id
Returns promise promise
putRevisionInfo
put revision info
Parameters
Returns promise promise
getRevisionsComparisonResult
get revision comparision result
Parameters
id
string division (model) idrevisionNumber1
number revision number 1revisionNumber2
number revision number 2
Returns promise promise
compareRevisions
compare revisions
Parameters
id
string division(model) idrevisionNumber1
number revision number 1revisionNumber2
number revision number 2
Returns promise promise
rightsService
getRoles
get right roles
Parameters
projectId
string project id - if not specified return all roles
Returns promise promise
postUserRole
post user role
Parameters
Returns promise promise
putUserRole
put user role
Parameters
Returns promise promise
deleteUser
delete user
Parameters
projectId
string project id - if not specified return all roles
Returns promise promise
roles
get
get roles
Returns promise promise
share
post
post share
Parameters
data
json share data
Returns promise promise
slides
get
get slide
Parameters
slideId
string slide id
Returns promise promise
put
put slide
Parameters
Returns promise promise
delete
delete slide
Parameters
slideId
string slide id
Returns promise promise
postThumbnail
post thumbnail
Parameters
Returns promise promise
slideshows
get
get slideshow
Parameters
slideshowId
string slideshow id
Returns promise promise
put
put slideshow
Parameters
Returns promise promise
delete
delete slideshow
Parameters
slideshowId
string slideshow id
Returns promise promise
postSlide
post slide
Parameters
Returns promise promise
getSlides
get slides
Parameters
slideshowId
string slideshow id
Returns promise promise
postThumbnail
post slideshow thumbnail
Parameters
Returns promise promise
getThumbnail
get slideshow thumbnail
Parameters
thumbnailId
string thumbnail id
Returns promise promise
structures
postStructure
post structure
Parameters
Returns promise promise
postSubNode
post sub node
Parameters
Returns promise promise
postAssignedObject
post assigned object - assign object to structure
Parameters
structureId
string structure idobjectId
string object idvarianttype
string variant typedata
json data
Returns promise promise
attributeAssign
assign attribute to structure
Parameters
projectId
string project idstructureId
string structure idattributeId
string attribute idvarianttype
string variant type
Returns promise promise
deleteAssignedObject
delete assigned object from structure
Parameters
Returns promise promise
getStructure
get structure - is structure id is empty return all structures with specific type
Parameters
Returns promise promise
getTopology
get structure topology
Parameters
structureId
string structure idvarianttype
string variant typeattributes
boolean flag if result should contain attributes
Returns promise promise
copyStructure
copy structure
Parameters
structureId
string structure iddata
json datacopyElements
boolean copy elementsselectedVariantType
string desired variant type
Returns promise promise
putStructure
put structure
Parameters
Returns promise promise
reorderStructure
reorder structure
Parameters
Returns promise promise
deleteStructure
delete structure
Parameters
structureId
string structure id
Returns promise promise
deleteAllProjectStructures
delete all project structures
Parameters
projectId
string project id
Returns promise promise
postVariantType
post variant type
Parameters
Returns promise promise
getVariantType
get variant type
Parameters
Returns promise promise
deleteVariantType
delete variant type
Parameters
Returns promise promise
copyElementsToVariant
copy elements to variant
Parameters
projectId
string project idvarianttype
string variant typevariant
json json string with variant data
Returns promise promise
teamActionsRights
get
get team action rights
Parameters
id
string team id
Returns promise promise
teams
get
get team data if id is not specified return list of teams
Parameters
id
string team id - if not specified return list of teams
Returns promise promise
postTeam
post team
Parameters
data
json team data
Returns promise promise
putTeam
put team
Parameters
Returns promise promise
deleteTeam
delete team
Parameters
teamId
string team id
Returns promise promise
getAccountSettings
get team account settings
Parameters
teamId
string team id
Returns promise promise
getRestrictions
get team restrictions
Parameters
teamId
string team id
Returns promise promise
terms
get
get terms
Parameters
language
string terms language
Returns promise promise
units
post
post units
Parameters
data
json units data
Returns promise promise
get
get unit - if id is not specified return all units
Parameters
unitId
string unit id
Returns promise promise
put
put unit
Parameters
Returns promise promise
delete
delete unit
Parameters
unitId
string unit id
Returns promise promise
user
get
get user
Parameters
token
[type] [description]
Returns promise [description]
put
put
Parameters
userId
[type] [description]data
[type] [description]token
[type] [description]
Returns promise promise
post
post user
Parameters
data
[type] [description]
Returns promise [description]
postPhoto
post user photo
Parameters
data
[type] image data
Returns promise [description]
getPhoto
get user photo
Returns [type] [description]
putPassword
put (change) password
Parameters
data
[type] [description]
Returns promise promise
getSubscriptions
get user subscriptions
Parameters
id
string user id
Returns promise promise
users
post
post users
Parameters
data
json [description]
Returns promise promise
exist
check if user exists
Parameters
email
string user email
Returns promise promise
put
put user
Parameters
userId
string user iddata
Returns promise promise
delete
delete user
Parameters
userId
string user id
Returns promise promise