Bimplus WebSDK version : 0.0.

...

98

Table of Contents

• calculateCutSection
• api
  • applicationSettings
    • postSettings
    • getSettings
    • putSettings
    • deleteSettings
    attachments
    • get
    • download
    • put
    • post
    • delete
    • postVersion
    • getAllVersions
    attributeTemplates
    • post
    • get
    • put
    • delete
    authorize
    • post
    • forgotPassword
    • checkAccessToken
    • requestCrossToken
    clashDetection
    • detectAllClashes
    • detectDisciplinesClashes
    • getFilters
    • calculateClashes
    • getFilterResults
    • createClashRule
    • deleteClashRule
    • getAllClashRules
    comments
    • get
    • delete
    • put
    customTables
    • get
    • post
    dataProtection
    • get
    elementTypes
    • get
    • getDisciplines
    • getAttributeTemplates
    • getTopology
    • getProjectTopology
    exportService
    • exportObjects
    • exportModel
    freeAttributeGroups
    • _getUrl
    • post
    • get
    • put
    • delete
    • getFreeAttributes
    freeAttributes
    • _getUrl
    • post
    • get
    • put
    • delete
    • getTopology
    • getFilteredAttributes
    groupActionsRights
    • get
    hiddenCalculation
    • calculate
    hyperlinks
    • get
    • delete
    • put
    importService
    • postModel
    • postModelLandXML
    imprints
    • get
    invitations
    • get
    • getProjectInvitations
    • post
    • delete
    • put
    • accept
    • getInvitation
    issues
    • post
    • get
    • postPin
    • getPins
    • deletePins
    • postComment
    • getComments
    • deleteComments
    • postAttachment
    • getAttachments
    • deleteAttachments
    • put
    • delete
    • getRights
    • getIssueTypes
    • importBcf
    • updateImportBcf
    • exportBcf
    • exportExcel
    locks
    • lockObject
    • checkLocked
    • deleteLock
    members
    • post
    • get
    • putUser
    • deleteUser
    messages
    • post
    • getUserMessages
    • getUserDashboardMessages
    • getSentUserMessages
    • getSentGroupMessages
    • get
    • getFiltered
    • deleteMessage
    • markAsRead
    • updateDashboardAdditionalData
    • addDashboardMessageAttachment
    • getMessagingGroupsDetails
    • getMessagingGroupsDetails
    models
    • get
    • head
    • getDisciplines
    • getRevisions
    • postRevision
    • put
    • download
    • delete
    • move
    objectFilters
    • get
    • getFilteredObjects
    • applyFilter
    • post
    • put
    • delete
    • getFilter
    objects
    • post
    • get
    • getInternal
    • head
    • getTopology
    • getGeometryThreeJS
    • getGeometryTemplatesThreeJS
    • getGeometryCompressed
    • getProperties
    • put
    • postComment
    • getComments
    • deleteComments
    • postAttachment
    • getAttachments
    • deleteAttachments
    • postHyperlink
    • getHyperlinks
    • deleteHyperlinks
    • delete
    • getAttributes
    • getAttributeValues
    • getComplexPropertiesTopology
    • postThumbnail
    • addChildObject
    • getReports
    pins
    • get
    • delete
    • put
    projectActionsRights
    • get
    projectAttributeTemplates
    • post
    • get
    • put
    • delete
    • copyFrom
    projects
    • post
    • put
    • get
    • delete
    • getModels
    • getModelTypes
    • getFreeAttrModelTypes
    • postModel
    • getMembers
    • postMember
    • putMember
    • deleteMember
    • getPins
    • putProject
    • postAttachment
    • getAttachments
    • deleteAttachments
    • getTopology
    • getSpots
    • postThumbnail
    • getThumbnail
    • getComments
    • getHyperlinks
    • getIssues
    • getIssuesShortInfo
    • postSlideshow
    • getSlideshows
    • deleteSlideshows
    • getProjectInfo
    revisions
    • postRevision
    • getRevisionList
    • getRevisionInfo
    • putRevisionInfo
    • getRevisionsComparisonResult
    • compareRevisions
    rightsService
    • getRoles
    • postUserRole
    • putUserRole
    • deleteUser
    roles
    • get
    • getAllRights
    • deleteRole
    • deleteRole
    • getRoleDetails
    • updateRole
    sectionCut
  • selections
    • post
    • get
    • getAllSelections
    • delete
    share
    • post
    slides
    • get
    • put
    • delete
    • postThumbnail
    slideshows
    • get
    • put
    • delete
    • postSlide
    • getSlides
    • postThumbnail
    • getThumbnail
    structures
    • postStructure
    • postStructureTopology
    • postSubNode
    • postAssignedObject
    • attributeAssign
    • deleteAssignedObject
    • getStructure
    • getTopology
    • getTopologyStructure
    • resetTopologyStructure
    • copyStructure
    • putStructure
    • reorderStructure
    • deleteStructure
    • deleteAllProjectStructures
    • postVariantType
    • getVariantType
    • deleteVariantType
    • copyElementsToVariant
    teamActionsRights
    • get
    teams
    • get
    • postTeam
    • putTeam
    • deleteTeam
    • getAccountSettings
    • getRestrictions
    terms
    • get
    units
    • post
    • get
    • put
    • delete
    user
    • get
    • put
    • post
    • postPhoto
    • getPhoto
    • putPassword
    • getSubscriptions
    userGroups
    • postGroup
    • getGroups
    • getUsers
    • deleteGroup
    • putGroup
    • assignUser
    users
    • post
    • exist
    • put
    • delete
    • setSubscriptions
    userSettings
    • postSettings
    • getSettings

...

calculateCutSection

calculate cut

Parameters

• projectId string project id
• cuttingPoint v3
• cuttingDirection v3
• async boolean run async flag (optional, default false)

Returns promise promise

api

Parameters

• config config json api config

applicationSettings

...

Parameters

• data json calculation data
• topology

Returns promise promise

getFilterResults

...

• projectId string project id
• filterId string filter id
• topology

Returns promise promise

comments

get

createClashRule

createClashRuleget comments

Parameters

• id projectIdstring comments id project id
• data JSON filter definition data

Returns promise promise

...

deleteClashRule

delete commentdeleteClashRule

Parameters

• id ruleIdstring comments id

Returns promise promise

put

getAllClashRules

get all clash filters (new method)put comment

Parameters

• id projectIdstring comments id project id

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

• id string comments id
• data json data json comment data

Returns promise promise

...

Returns promise promise

exportModel

export modelIdmodel revision

Parameters

• projectId string project id
• modelId string model id
• revisionNr string revision number, if not defined, last revision is exported

Returns promise promise

freeAttributeGroups

...

• projectId string project id
• layerId string for filtering attributes from requested discipline
• type string for filtering attributes from special objects like 'Tasks', 'Attachments', 'Structures'

Returns promise promise

groupActionsRights

get

get group actions rights

Returns promise promise

hiddenCalculation

...

• projectId string project id
• view json view params
  • view.cameraViewPoint string e.g. { X : camPos.x , Y: camPos.y, Z: camPos.z},
  • view.cameraDirection string e.g. { X : camDir.x , Y: camDir.y, Z: camDir.z}
  • view.cameraUpVector string e.g. { X : 0, Y : 1, Z: 0},
  • view.fieldOfView number field of view
• clippingPlanes
• filename string file name
• async boolean run async flag

Returns promise promise

hyperlinks

get

get hyperlink

Parameters

• id string hyperlink id

...

Returns promise promise

importService

postModel

post model

Parameters

• projectId string project id
• modelId string model id
• data json data
• progressCallback

Returns promise promise

postModelLandXML

post model - land XML

Parameters

• projectId string project id
• modelId string model id
• data json data
• progressCallback

Returns promise promise

imprints

get

get data protection

Parameters

...

Returns promise promise

invitations

get

get invitation

Parameters

• id string invitation id, if id is null return all invitations

Returns promise promise

getProjectInvitations

get all project invitation

Parameters

• prjId
• id string invitation id, if id is null return all invitations

...

• id string invitation id
• data json string

Returns promise promise

...

getInvitation

post

post issue

get invitation info

Parameters

• projectId idstring project invitation id
• data json data string

Returns promise promise

...

issues

get issue

post

post issue

Parameters

• projectId string project id
• data json data

Returns promise promise

get

get issue

Parameters

• id string issue id

...

• projectId string project id - if not specified export all team issues
• data json data
• version

Returns promise promise

exportExcel

...

• data json member data

Returns promise promise

get

get team members

Returns promise promise

...

getUserMessages

get user messages

Parameters

• userId string user id

Returns promise promise

getUserDashboardMessages

get user dashboard essages

Parameters

• userId string user id

...

• userId string user id

Returns promise promise

get

get message

Parameters

• messageId string message id

...

modify additionaldata part of message (title, content, messagelink and picturelink)

Parameters

• messageId string message id
• additionalData string message additionalData

Returns promise promise

addDashboardMessageAttachment

adding attachment to dashboard message

Parameters

• messageId string message id
• additionalData string message additionalData (formData with set files or images(blobs))
• config

Returns promise promise

getMessagingGroupsDetails

...

Returns promise promise

models

get

get model

Parameters

• modelId string model id

...

Returns promise promise

objectFilters

get

get object filters

Parameters

...

• projectId string project id
• filterId string filter id
• properties string properties
• topology string topology (string) returns results organized with respect to existing topology

Returns promise promise

applyFilter

...

• data json object filter data
• projectId string projectId

Returns promise promise

put

put object filter

...

Returns promise promise

delete

delete object filter

Parameters

• id string object filter id

Returns promise promise

getFilter

ger object filter info

Parameters

• filterId
• id string object filter id

Returns promise promise

...

• data json data

Returns promise promise

get

get object

Parameters

• objectId string object id
• revision nubmer revision number
• properties string properties
• projectId string project id
• shortInfo boolean true = return results without attributes and without localizedAttributeGroups

Returns promise promise

getInternal

...

• objectId string object id
• revision number revision number
• hideElements boolean hide elements flag
• shortInfo boolean short info flag
• batch string Response batch id or undefined if no batching used

Returns promise promise

getGeometryThreeJS

...

• objectId string object id
• disciplineId string discipline id
• chunked boolean chunked flag
• revision number revision number
• lod string level of detail
• properties string properties
• batch string Response batch id or undefined if no batching used

Returns promise Returns promise promise

getGeometryTemplatesThreeJS

...

• objectId string object id
• disciplineId string discipline id
• chunked boolean chunked flag
• revision number revision number
• lod string level of detail
• batch string Response batch id or undefined if no batching used

Returns promise promise

getGeometryCompressed

...

• objectId string object id
• data json data
• uploadProgress
• documentFolderId string document folder id

Returns promise promise

getAttachments

...

Returns promise promise

delete

delete object

Parameters

• objectId

Returns promise promise

getAttributes

...

• objectId string object id
• documentVersion number document version
• projectId string projectId - required when resource (objectId) represents an user
• revision number revision number

Returns promise promise

getAttributeValues

...

• projectId string project id
• attributeId string attribute id

Returns promise promise

...

getComplexPropertiesTopology

get

...

get pinsComplexProperties topology for element

Parameters

• id objectIdstring pin object id

Returns promise promise

delete

delete pin

Parameters

• id string pin idrevision string revision

Returns promise promise

...

postThumbnail

put pinpost thumbnail

Parameters

• id objectIdstring pin object id
• data json data
• uploadProgress

Returns promise promise

projectActionsRights

get

get project action rights

Returns promise promise

projectAttributeTemplates

post

[description]

addChildObject

post addChildObjectpost 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

• id string template id
• data json template data

Returns promise promise

delete

delete project template attribute

Parameters

• minimal form is: { "parent": "{{parentId}}", "type": "Proxy", “elementtyp”: "30114B52-BC05-47C1-80B5-C7D5485D5831" "attributes": { "general": { "name": "IPE200_Column" }, "element": { "divisionid": "{{divisionId}}", "logparentid": "{{parentId}}" } } }

Returns promise [description]

getReports

get object reports

Parameters

• objectId string object id
• version string version
• action

Returns promise promise

pins

get

get pins

Parameters

• id string pin id string template id

Returns promise promise

copyFrom

delete

delete pincopy project template attribute

Parameters

• fromId string source template idtargetId string destination template id

Returns promise promise

projects

post

post project

Parameters

• data json project data pin id

Returns promise promise

put

put projectpin

Parameters

• id string project pin id
• data json project data

Returns promise promise

projectActionsRights

get

get project action rights

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 - if no id is specified return list of all projects

Parameters

• id string project idnoDisciplines boolean flag to put disciplines in response template id

Returns promise [description] promise

...

put

delete put project template attribute

Parameters

• projectId idstring project template id
• data json template data

Returns promise [description] promise

...

delete

get project's modelsdelete project template attribute

Parameters

• projectId idstring project template id

Returns promise [description] promise

postModel

copyFrom

copy project template attributepost model

Parameters

• projectId fromIdstring project id
• data json data

Returns promise [description]

getMembers

get project members

Parameters

• source template id
• targetId string destination template projectId string project id

Returns promise [description]

...

promise

projects

post

post memberproject

Parameters

...

• data json project data

Returns promise promise [description]

...

put

put memberproject

Parameters

• projectId id string project id
• data json project data

Returns promise promise [description]

deleteMember

get

get project - if no id is specified return list of all projectsdelete member

Parameters

• projectId id string project iddata json data
• noDisciplines boolean flag to put disciplines in response
• teamSlug string team slug, if defined, all projects for this team slug will be loaded

Returns promise [description]

...

delete

get delete project pins

Parameters

• projectId string project id

Returns promise [description]

...

getModels

put get project's models

Parameters

• projectId string project iddata json data

Returns promise [description]

postAttachment

post attachment

Parameters

• projectId string project id
• data json data

getModelTypes

get all model types for given team

Returns promise [description]

getAttachments

get attachments

Parameters

...

getFreeAttrModelTypes

get all model types for given team base on free attr information

...

Returns promise [description]

...

postModel

delete attachmentpost model

Parameters

• projectId string project id
• data json data

Returns promise [description]

...

getMembers

get project 's topologymembers

Parameters

• projectId string project id

Returns promise [description]

...

postMember

get spotspost member

Parameters

• projectId string project id
• data json data

Returns promise [description]

...

putMember

post thumbnailput member

Parameters

• projectId string project id
• data json datauploadProgress

Returns promise [description]

getThumbnail

get thumbnail

Parameters

• thumbnailId string thumbnail id

Returns promise [description]

getComments

get comments

deleteMember

delete member

Parameters

• projectId string project id
• data json data

Returns promise [description]

...

getPins

get hyperlinksproject pins

Parameters

• projectId string project id

Returns promise [description]

getIssues

putProject

put projectget issues (tasks)

Parameters

• projectId string project id
• data json data

Returns promise [description]

...

postAttachment

post slideshowattachment

Parameters

• projectId string project id
• data json data

Returns promise [description]

...

getAttachments

get slideshowsattachments

Parameters

• projectId string project id
• revision number revision number
• queryParams json json with params e.g. {projectOnly : true}

Returns promise [description]

...

deleteAttachments

delete slideshowsattachment

Parameters

• projectId string project id

Returns promise [description]

...

getTopology

get project info's topology

Parameters

• projectId string project id

Returns promise [description]

getSpots

get spots

Parameters

• projectId string project id

Returns promise [description]

...

postThumbnail

postRevision

post revisionthumbnail

Parameters

• id string division (model) projectId string project id
• data json data
• uploadProgress

Returns promise promise [description]

...

getThumbnail

get revisions listthumbnail

Parameters

• id string division (model) thumbnailId string thumbnail id

Returns promise promise [description]

...

getComments

get revision infocomments

Parameters

• id projectIdstring revision project id

Returns promise promise [description]

putRevisionInfo

getHyperlinks

get hyperlinksput revision info

Parameters

• id projectIdstring revision project id
• data json data

Returns promise promise

getRevisionsComparisonResult

Returns promise [description]

getIssues

get issues (tasks)get revision comparision result

Parameters

• id string division (model) id
• revisionNumber1 number revision number 1
• revisionNumber2 number revision number 2projectId string project id

Returns promise promise [description]

compareRevisions

getIssuesShortInfo

get issues short info(tasks)compare revisions

Parameters

• id string division(model) id
• revisionNumber1 number revision number 1
• revisionNumber2 number revision number 2projectId string project id

Returns promise promise [description]

...

postSlideshow

getRoles

post slideshow

Parameters

• projectId string project id
• data json data

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 infoget right roles

Parameters

• projectId string project id - if not specified return all roles

Returns promise promise

postUserRole

post user role

Parameters

• projectId string project id - if not specified return all roles
• data json role data

Returns promise promise

putUserRole

put user role

Parameters

• projectId string project id - if not specified return all roles
• data json role data

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

revisions

postRevision

post revision

Parameters

• id string division (model) id
• data json data

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

• id string revision id
• data json data

Returns promise promise

getRevisionsComparisonResult

get revision comparision result

Parameters

• id string division (model) id
• revisionNumber1 number revision number 1
• revisionNumber2 number revision number 2
• queryParams

Returns promise promise

compareRevisions

compare revisions

Parameters

• id string division(model) id
• revisionNumber1 number revision number 1
• revisionNumber2 number revision number 2
• queryParams

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

• projectId string project id - if not specified return all roles
• data json role data

Returns promise promise

putUserRole

put user role

Parameters

• projectId string project id - if not specified return all roles
• data json role data

Returns promise promise

deleteUser

delete user

Parameters

• projectId string project id - if not specified return all roles

Returns promise promise

roles

get

get roles

Parameters

• rights boolean
• customrole
• customRole boolean if true, returns only editable roles

Returns promise promise When query parameter "rights=false" is defined, the API call will returns all roles. i.e. not only roles which contains resources and right definitions.When query parameter is missing, the API call returns only roles which includes resources and rights definitions.

getAllRights

get all rights

Parameters

• filter JSON { globalfreeattributes:true/false global:true/false, project:true/false, document:true/false, layer:true/false }

Returns promise promise

deleteRole

create new role

Parameters

• newRole json

Returns promise promise newRoleJSON Structure: prop-name mandatory/optional Type Description resources mandatory JSON Array Array of the resource definition objects for which the role is valid id optional string (guid) Id of the role name mandatory string The name of the role parent optional string (guid) The Id of the parent role customRole mandatory boolean When this flag is true the role is custom role otherwise will role is 'built in' role> > JSON Structure of the resource definition object: > > resource mandatory string Describe kind of right e.g. "UserRightGlobal" or "UserRightLayer" > > rights mandatory JSON Array Array of the strings of rights e.g.: "FreeAttributeView", "MEP: 2", "MEPEdit" > > <<

deleteRole

delete existing role

Parameters

• roleId string

Returns promise promise

getRoleDetails

get details of role

Parameters

• roleId string

Returns promise promise

updateRole

update existing role

Parameters

• roleId string
• updatedRole json (see create newRole for JSON details)

Returns promise promise

sectionCut

selections

post

Creates a new selection object. The structure of the Selection objects is the same like the structure of the Export Object Selection.

...

• projectId string project id
• data json selection data

Returns promise promise

get

get selection object details

...

Returns promise promise

slides

get

get slide

Parameters

• slideId string slide id

...

• slideId string slide id

Returns promise promise

postThumbnail

post thumbnail

Parameters

• slideId string slide id
• data json thumbnail data

Returns promise promise

slideshows

get

get slideshow

Parameters

• slideshowId string slideshow id

...

• slideshowId string slideshow id

Returns promise promise

postThumbnail

post slideshow thumbnail

Parameters

...

• structureId string structure id
• varianttype string variant type
• attributes boolean flag if result should contain attributesif result should contain attributes

Returns promise promise

getTopologyStructure

get toplogy structure

Parameters

• projectId [type] [description]

Returns promise promise

resetTopologyStructure

create or reset toplogy structure

Parameters

• projectId [type] [description]

Returns promise promise

copyStructure

...

Returns promise promise

teamActionsRights

get

get team action rights

Returns promise promise

teams

get

get team data if id is not specified return list of teams

...

Returns promise promise

terms

get

get terms

Parameters

• language string terms language

...

• data json units data

Returns promise promise

get

get unit - if id is not specified return all units

...

Returns promise promise

put

put unit

Parameters

• unitId string unit id
• data json unit data

Returns promise promise

delete

delete unit

Parameters

• unitId string unit iddata json unit dataid

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

delete unitpost user

Parameters

• unitId string unit iddata [type] [description]

Returns promise promise [description]

...

postPhoto

get

get post user photo

Parameters

• token data[type] [description] image data

Returns promise [description]

...

getPhoto

put

Parameters

...

get user photo

Returns [type] [description]

putPassword

put (change) password

Parameters

• data [type] [description]token [type] [description]

Returns promise promise

getSubscriptions

get user subscriptions

Parameters

• id string user id

Returns promise promise

...

userGroups

postGroup

post usergroup

Parameters

• projectId string project id
• data [type] [description] json data

Returns promise [description]

postPhoto

getGroups

get groupspost user photo

Parameters

• data [type] image dataprojectId string project id

Returns promise [description] promise

getPhoto

get user photo

Returns [type] [description]

putPassword

put (change) password

Parameters

getUsers

get users of a group

Parameters

• groupId string group id

Returns promise promise

deleteGroup

delete group

Parameters

• groupId string group id

Returns promise promise

putGroup

put group

Parameters

• groupId string group id
• data json datadata [type] [description]

Returns promise promise

...

assignUser

get user subscriptionsassign user to a group or change group role

Parameters

• id groupIdstring user group id
• data json data

Returns promise promise

users

...

Returns promise promise

delete

delete user

Parameters

• userId string user id

Returns promise promise

setSubscriptions

create one or more trial account setting(s)

Parameters

• userId string user id
• data json [description]

Returns promise promise

userSettings

...