You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

Bimplus WebSDK version : 0.0.32

Table of Contents

 

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

  • settingId string settings id
  • data json settins data

Returns promise promise

 

deleteSettings

delete settings

Parameters

Returns promise promise

 

attachments

 

get

get attachment

Parameters

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

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

Returns promise promise

 

put

put attribute template

Parameters

Returns promise promise

 

delete

delete attribute template

Parameters

Returns promise promise

 

authorize

 

post

post authorization

Parameters

  • username string user name
  • password password password
  • applicationId string application id - Please contact Allplan company to obtain application id !

Returns promise promise

 

forgotPassword

forgot password

Parameters

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

Returns promise promise

 

delete

delete comment

Parameters

Returns promise promise

 

put

put comment

Parameters

Returns promise promise

Returns [type] [description]

 

customTables

 

get

get custom tables

Parameters

  • objectId string object id
  • variantTypeId string? variant type id

Returns promise promise

 

elementTypes

 

get

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

Parameters

Returns promise promise

 

getDisciplines

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

Parameters

Returns promise promise

 

getAttributeTemplates

get attribute templates

Parameters

  • id string element type id
  • queryParams 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

Returns promise promise

 

exportService

 

exportObjects

export objects

Parameters

  • projectId string project id
  • elementTypeId string element type id

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

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

Returns promise promise

 

get

get free attribute group

Parameters

  • freeAttributeGroupId string free attribute group id
  • content boolean flag if it is content attribute group

Returns promise promise

 

put

put free attribute group

Parameters

  • freeAttributeGroupId string free attribute group id
  • data json group data
  • content boolean flag if it is content attribute group

Returns promise promise

 

delete

delete free attribute group

Parameters

  • freeAttributeGroupId string free attribute group id
  • content boolean flag if it is content attribute group

Returns promise promise

 

getFreeAttributes

get free attribute group

Parameters

  • freeAttributeGroupId string free attribute group id
  • content 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

  • 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

Parameters

  • freeAttributeId string attribute id
  • content boolean flag if it is content attribute
  • queryParams string filter query

Returns promise promise

 

put

put free attribute

Parameters

  • freeAttributeId string attribute id
  • data json attribute data
  • content boolean flag if it is content attribute

Returns promise promise

 

delete

delete free attribute

Parameters

  • freeAttributeId string attribute id
  • content boolean flag if it is content attribute

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 id
  • layerId string for filtering attributes from requested discipline
  • type string for filtering attributes from special objects like 'Tasks', 'Attachments', 'Structures'

Returns promise promise

 

hiddenCalculation

 

calculate

calculate hidden

Parameters

  • 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
  • filename string file name
  • async boolean run async flag

Returns promise promise

 

 

get

get hyperlink

Parameters

Returns promise promise

 

delete

delete hyperlink

Parameters

Returns promise promise

 

put

put hyperlink

Parameters

Returns promise promise

 

importService

 

postModel

post model

Parameters

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

Returns promise promise

 

issues

 

post

post issue

Parameters

Returns promise promise

 

get

get issue

Parameters

Returns promise promise

 

postPin

post issue's pin

Parameters

Returns promise promise

 

getPins

get issue's pins

Parameters

Returns promise promise

 

deletePins

delete issues pins

Parameters

Returns promise promise

 

postComment

post issue's comment

Parameters

Returns promise promise

 

getComments

get issues comments

Parameters

Returns promise promise

 

deleteComments

delete issue's comments

Parameters

Returns promise promise

 

postAttachment

post issue's attachment

Parameters

Returns promise promise

 

getAttachments

get issue's attachment

Parameters

Returns promise promise

 

deleteAttachments

delete issue's attachment

Parameters

Returns promise promise

 

put

put issue

Parameters

Returns promise promise

 

delete

delete issue

Parameters

Returns promise promise

 

getRights

get issue rights

Parameters

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

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

Returns promise promise

 

exportExcel

export issue in excel format

Parameters

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

Returns promise promise

 

locks

 

lockObject

lock object

Parameters

Returns promise promise

 

checkLocked

check if object is locked

Parameters

Returns promise promise

 

deleteLock

delete object lock

Parameters

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

Returns promise promise

 

get

get message

Parameters

Returns promise promise

 

getFiltered

get filtered messages

Parameters

Returns promise promise

 

deleteMessage

delete message

Parameters

Returns promise promise

 

markAsRead

mark message as readed

Parameters

Returns promise promise

 

models

 

get

get model

Parameters

Returns promise promise

 

head

get head

Parameters

Returns [type] [description]

Returns promise promise

 

getDisciplines

get disciplines

Parameters

Returns promise promise

 

getRevisions

get revisions

Parameters

Returns promise promise

 

postRevision

post revision

Parameters

Returns promise promise

 

put

put model

Parameters

Returns promise promise

 

download

download model

Parameters

Returns promise promise

 

delete

delete model

Parameters

Returns promise promise

 

move

move model

Parameters

  • divisionId string division id
  • moveData json move data e.g. { deltax:delta.x,deltay:delta.y,delta_z:delta.z }

Returns promise promise

 

objectFilters

 

get

get object filters

Parameters

  • disciplineId string discipline id
  • projectId string project id

Returns promise promise

 

getFilteredObjects

get filtered objects

Parameters

Returns promise promise

 

applyFilter

apply filter

Parameters

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

Returns promise promise

 

objects

 

post

post object

Parameters

Returns promise promise

 

get

get object

Parameters

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

Returns promise promise

 

getInternal

get internal

Parameters

Returns promise promise

 

head

get head

Parameters

Returns promise promise

 

getTopology

get object topology

Parameters

  • objectId string object id
  • revision number revision number
  • hideElements boolean hide elements flag

Returns promise promise

 

getGeometryThreeJS

get object geometry in three js format

Parameters

Returns promise promise

 

getGeometryTemplatesThreeJS

get geometry templates in three js format

Parameters

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

Returns promise promise

 

deleteComments

delete object comments

Parameters

Returns promise promise

 

postAttachment

post object attachemnt

Parameters

  • objectId string object id
  • data json data
  • uploadProgress

Returns promise promise

 

getAttachments

get object attachments

Parameters

Returns promise promise

 

deleteAttachments

delete all object's attachment

Parameters

Returns promise promise

 

post object hyperlink

Parameters

Returns promise promise

 

get object hyperlinks

Parameters

Returns promise promise

 

delete all object's hyperlinks

Parameters

Returns promise promise

 

delete

delete object

Parameters

Returns promise promise

 

getAttributes

get object attributes

Parameters

  • objectId string object id
  • documentVersion number document version

Returns promise promise

 

pins

 

get

get pins

Parameters

Returns promise promise

 

delete

delete pin

Parameters

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

Returns promise promise

 

put

put project template attribute

Parameters

Returns promise promise

 

delete

delete project template attribute

Parameters

Returns promise promise

 

copyFrom

copy project template attribute

Parameters

  • fromId string source template id
  • targetId string destination template id

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

  • id string project id
  • noDisciplines boolean flag to put disciplines in response

Returns promise [description]

 

delete

delete project

Parameters

Returns promise [description]

 

getModels

get project's models

Parameters

Returns promise [description]

 

postModel

post model

Parameters

Returns promise [description]

 

getMembers

get project members

Parameters

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

Returns promise [description]

 

putProject

put project

Parameters

Returns promise [description]

 

postAttachment

post attachment

Parameters

Returns promise [description]

 

getAttachments

get attachments

Parameters

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

Returns promise [description]

 

deleteAttachments

delete attachment

Parameters

Returns promise [description]

 

getTopology

get project's topology

Parameters

Returns promise [description]

 

getSpots

get spots

Parameters

Returns promise [description]

 

postThumbnail

post thumbnail

Parameters

  • projectId string project id
  • data json data
  • uploadProgress

Returns promise [description]

 

getThumbnail

get thumbnail

Parameters

  • thumbnailId string thumbnail id

Returns promise [description]

 

getComments

get comments

Parameters

Returns promise [description]

 

getHyperlinks

get hyperlinks

Parameters

Returns promise [description]

 

getIssues

get issues (tasks)

Parameters

Returns promise [description]

 

postSlideshow

post slideshow

Parameters

Returns promise [description]

 

getSlideshows

get slideshows

Parameters

Returns promise [description]

 

deleteSlideshows

delete slideshows

Parameters

Returns promise [description]

 

getProjectInfo

get project info

Parameters

Returns promise promise

 

revisions

 

postRevision

post revision

Parameters

Returns promise promise

 

getRevisionList

get revisions list

Parameters

Returns promise promise

 

getRevisionInfo

get revision info

Parameters

Returns promise promise

 

putRevisionInfo

put revision info

Parameters

Returns promise promise

 

getRevisionsComparisonResult

get revision comparision result

Parameters

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

Returns promise promise

 

compareRevisions

compare revisions

Parameters

  • id string division(model) id
  • revisionNumber1 number revision number 1
  • revisionNumber2 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

  • 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

 

share

 

post

post share

Parameters

  • data json share data

Returns promise promise

 

slides

 

get

get slide

Parameters

Returns promise promise

 

put

put slide

Parameters

Returns promise promise

 

delete

delete slide

Parameters

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

Returns promise promise

 

attributeAssign

assign attribute to structure

Parameters

  • projectId string project id
  • structureId string structure id
  • attributeId string attribute id
  • varianttype 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

  • projectId [type] [description]
  • structureId string structure id
  • type string requested structure type

Returns promise promise

 

getTopology

get structure topology

Parameters

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

Returns promise promise

 

copyStructure

copy structure

Parameters

  • structureId string structure id
  • data json data
  • copyElements boolean copy elements
  • selectedVariantType string desired variant type

Returns promise promise

 

putStructure

put structure

Parameters

Returns promise promise

 

reorderStructure

reorder structure

Parameters

  • structureId string structure id
  • varianttype string variant type

Returns promise promise

 

deleteStructure

delete structure

Parameters

  • structureId string structure id

Returns promise promise

 

deleteAllProjectStructures

delete all project structures

Parameters

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 id
  • varianttype string variant type
  • variant json json string with variant data

Returns promise promise

 

teamActionsRights

 

get

get team action rights

Parameters

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

Returns promise promise

 

putTeam

put team

Parameters

Returns promise promise

 

deleteTeam

delete team

Parameters

Returns promise promise

 

getAccountSettings

get team account settings

Parameters

Returns promise promise

 

getRestrictions

get team restrictions

Parameters

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

Returns promise promise

 

put

put unit

Parameters

Returns promise promise

 

delete

delete unit

Parameters

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

Returns promise promise

 

users

 

post

post users

Parameters

  • data json [description]

Returns promise promise

 

exist

check if user exists

Parameters

Returns promise promise

 

put

put user

Parameters

Returns promise promise

 

delete

delete user

Parameters

Returns promise promise

  • No labels