Bimplus WebSDK version : 0.0.

...

51

Table of Contents

• 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
    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
    hiddenCalculation
    • calculate
    hyperlinks
    • get
    • delete
    • put
    importService
    • postModel
    imprints
    • get
    invitations
    • get
    • post
    • delete
    • put
    • accept
    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
    • getSentUserMessages
    • getSentGroupMessages
    • get
    • getFiltered
    • deleteMessage
    • markAsRead
    • updateDashboardAdditionalData
    • getMessagingGroupsDetails
    • getMessagingGroupsDetails
    models
    • get
    • head
    • getDisciplines
    • getRevisions
    • postRevision
    • put
    • download
    • delete
    • move
    objectFilters
    • get
    • getFilteredObjects
    • applyFilter
    • post
    • put
    • delete
    objects
    • post
    • get
    • getInternal
    • head
    • getTopology
    • getGeometryThreeJS
    • getGeometryTemplatesThreeJS
    • getGeometryCompressed
    • getProperties
    • put
    • postComment
    • getComments
    • deleteComments
    • postAttachment
    • getAttachments
    • deleteAttachments
    • postHyperlink
    • getHyperlinks
    • deleteHyperlinks
    • delete
    • getAttributes
    • getAttributeValues
    pins
    • get
    • delete
    • put
    projectActionsRights
    • get
    projectAttributeTemplates
    • post
    • get
    • put
    • delete
    • copyFrom
    projects
    • 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
    revisions
    • postRevision
    • getRevisionList
    • getRevisionInfo
    • putRevisionInfo
    • getRevisionsComparisonResult
    • compareRevisions
    rightsService
    • getRoles
    • postUserRole
    • putUserRole
    • deleteUser
    roles
    • get
    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
    • 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
    users
    • post
    • exist
    • put
    • delete
    userSettings
    • postSettings
    • getSettings

...

• objectId string object id
• variantTypeId string? variant type id
• revision nubmer revision number

Returns promise promise

...

post

get

get element types - if id is not specified it returns all element types

Parameters

post custom table

Parameters

• objectId string object id
• data json dataid string element type id

Returns promise promise

dataProtection

getDisciplines

get

get data protection

Parameters

• language string data protection language

Returns promise promise

elementTypes

get

get element types get element type disciplines - 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

...

• content boolean flag if it is content attribute group

Returns promise promise

post

post free attribute group

...

• data json group data
• content boolean flag if it is content attribute group

Returns promise promise

get

get free attribute group

Parameters

...

• content boolean flag if it is content attribute

Returns promise promise

post

post free attribute

Parameters

• data json attribute data
• content boolean flag if it is content attribute

Returns promise promise

get

get free attribute - if freeAttributeId is not specified return all

...

Returns promise promise

hyperlinks

get

get hyperlink

Parameters

• id string hyperlink id

...

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

Returns promise promise

imprints

get

get data protection

Parameters

• language string imprints language

Returns promise promise

invitations

get

get invitation

Parameters

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

Returns promise promise

post

post invitation

Parameters

...

Returns promise promise

issues

post

post issue

Parameters

• projectId string project id
• data json data

Returns promise promise

get

get issue

Parameters

• id string issue id

...

Returns promise promise

members

post

post member

Parameters

• data json member data

Returns promise promise

get

get team members

Returns promise promise

...

Returns promise promise

messages

post

post message

Parameters

• data json message data

...

• userId string user id

Returns promise promise

get

get message

Parameters

getSentUserMessages

get messages sent by user

Parameters

• userId string user id

Returns promise promise

getSentGroupMessages

get messages sent by user to all groups

Parameters

• userId string user id

Returns promise promise

get

get message

Parameters

• messageId string message id

...

• messageId string message id

Returns promise promise

models

get

get model

Parameters

updateDashboardAdditionalData

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

Parameters

• messageId string message id
• additionalData string message additionalDatamodelId string model id

Returns promise promise

...

getMessagingGroupsDetails

get headall messaging groups

Returns promise promise

getMessagingGroupsDetails

Get the messaging group details

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

...

Returns promise promise

objectFilters

get

get object filters

Parameters

...

• filterId string filter id

Returns promise promise

post

post object filter

Parameters

...

Returns promise promise

objects

post

post object

Parameters

• data json data

Returns promise promise

get

get object

Parameters

• objectId string object id
• revision nubmer revision number
• properties string properties

...

• objectId string object id
• data json data
• projectId

Returns promise promise

postComment

...

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

Returns promise promise

...

getAttributeValues

get

...

all objects of a project with existing attribute and its value

Parameters

• projectId string project id
• attributeId string attribute id

Returns promise promise

pins

get

get pins

Parameters

• id string pin id

get pins

Parameters

• id string pin id

Returns promise promise

delete

...

Returns promise promise

projectActionsRights

get

get project action rights

...

projectAttributeTemplates

post

post project attribute template

...

• data json template data

Returns promise promise

get

get project attribute template - if id is not specified return all templates

...

Returns promise promise

projects

post

post project

Parameters

• data json project data

...

• id string project id
• data json project data

Returns promise promise

get

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

...

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
• data json role data

Returns promise promise

deleteUser

• roles

Returns promise promise

roles

get

get roles

Returns promise promise

selections

post

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

Parameters

• projectId string project id
• data json selection data

Returns promise promise

get

get selection object details

Parameters

• selectionId string selection id

Returns promise [description]

getAllSelections

get all selections of the projectdelete user

Parameters

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

Returns promise promise

roles

get

...

[description]

delete

delete the selection

Parameters

• selectionId string selection id

Returns promise promise [description]

share

post

post share

Parameters

• data json share data

Returns promise promise

slides

get

get slide

Parameters

• slideId string slide id

...

• slideId string slide id
• data json slide data

Returns promise promise

delete

delete slide

Parameters

• slideId string slide id

...

Returns promise promise

slideshows

get

get slideshow

Parameters

• slideshowId string slideshow id

...

• slideshowId string slideshow id
• data json data

Returns promise promise

delete

delete slideshow

Parameters

...

postStructure

post structure

Parameters

• projectId string project id
• data json data

Returns promise promise

postStructureTopology

post structure topology

Parameters

• projectId string project id
• data json data

...

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

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

...

• unitId string unit id
• data json unit data

Returns promise promise

delete

delete unit

Parameters

• unitId string unit id

Returns promise promise

user

get

get user

Parameters

• token [type] [description]

...

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

Returns promise promise

post

post user

Parameters

• data [type] [description]

...

Returns promise promise

users

post

post users

Parameters

• data json [description]

...

• userId string user id
• data

Returns promise promise

delete

delete user

Parameters

• userId string user id

...