Versions Compared

Old Version 6

changes.mady.by.user Pavol Ziacek

Saved on

compared with

New Version Current

changes.mady.by.user Ilya Shavlyuk

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Bimplus WebSDK version : 0.0.

...

98

Table of Contents


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 json api config

...

Returns promise promise


authorize (obsolete)


post

post authorization

Parameters

...

Parameters

  • data json calculation data
  • topology

Returns promise promise


getFilterResults

...

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

Returns promise promise


createClashRule

createClashRule

Parameters

  • projectId string project id
  • data JSON filter definition data

Returns promise promise


deleteClashRule

deleteClashRule

Parameters

Returns promise promise


getAllClashRules

get all clash filters (new method)

Parameters

Returns promise promise


comments


get

get comments

Parameters

...

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

Returns promise promise

elementTypes

get


post

post custom table

Parameters

Returns promise promise


dataProtection


get

get data protection

Parameters

  • language string data protection language

Returns promise promise


elementTypes


get

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

...

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

...

  • 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

...

  • 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


calculate

...

  • 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



get

get hyperlink

Parameters

...

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

Returns promise promise

invitations

get


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

  • language string imprints language

Returns promise promise


invitations


get

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

Returns promise promise


post

post invitation

Parameters

...

Returns promise promise

...


getInvitation

post

get invitation info

Parameters

Returns promise promise


issues


post

post post issue

Parameters

Returns promise promise


get

get issue

Parameters

...

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

Returns promise promise


exportExcel

...

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

...

Returns promise promise


getUserDashboardMessages

get user dashboard essages

Parameters

Returns promise promise


getSentUserMessages

get messages sent by user

Parameters

Returns promise promise


getSentGroupMessages

get messages sent by user to all groups

Parameters

Returns promise promise


get

get message

Parameters

...

Returns promise promise

models

get


updateDashboardAdditionalData

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

Parameters

  • modelId messageIdstring model message id
  • additionalData string message additionalData

Returns promise promise

head


addDashboardMessageAttachment

adding attachment to dashboard messageget head

Parameters

  • modelId messageIdstring model id

...

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

Returns promise promise

...


getMessagingGroupsDetails

get disciplines

Parameters

all messaging groups

Returns promise promise


getMessagingGroupsDetails

Get the messaging group details

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

...

Returns promise promise


objectFilters


get

get object filters

Parameters

...

Returns promise promise

  • topology string topology (string) returns results organized with respect to existing topology

Returns promise promise


applyFilter

apply filter

Parameters

Returns promise promise


post

post object filter

Parameters

  • data json object filter data
  • projectId string projectId

Returns promise promise


put

put object filter

...

Returns promise promise


delete

delete object filter

Parameters

Returns promise promise


getFilter

ger object filter info

Parameters

  • filterId
  • id string object filter id

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
  • 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

...

Returns promise promise


postComment

...

  • 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

get

...

all objects of a project with existing attribute and its value

Parameters

get pins

Parameters

Returns promise promise

delete


getComplexPropertiesTopology

get ComplexProperties topology for elementdelete pin

Parameters

Returns promise promise

...


postThumbnail

put pinpost thumbnail

Parameters

Returns promise promise

projectActionsRights

get

...

  • uploadProgress

Returns promise promise [description]

...


addChildObject

post

...

post project attribute templateaddChildObject

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

  • 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

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

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
  • teamSlug string team slug, if defined, all projects for this team slug will be loaded

Returns promise [description]


delete

delete project

Parameters

Returns promise [description]


getModels

get project's models

Parameters

Returns promise [description]


getModelTypes

get all model types for given team

Returns promise [description]


getFreeAttrModelTypes

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

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

Returns promise [description]

...


getComments

get project's modelscomments

Parameters

Returns promise [description]

...


getHyperlinks

post modelget hyperlinks

Parameters

Returns promise [description]

...


getIssues

get project membersissues (tasks)

Parameters

Returns promise [description]

postMember


getIssuesShortInfo

get issues short info(tasks)post member

Parameters

Returns promise [description]

...


postSlideshow

put memberpost slideshow

Parameters

Returns promise [description]

...


getSlideshows

delete memberget slideshows

Parameters

Returns promise [description]

getPins


deleteSlideshows

delete slideshowsget project pins

Parameters

Returns promise [description]

...


getProjectInfo

put get project info

Parameters

Returns promise [description]

...

promise


revisions


postRevision

post attachmentrevision

Parameters

Returns promise [description] promise

...


getRevisionList

get attachmentsrevisions list

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

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
  • 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 roleget comments

Parameters

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

Returns promise [description] promise

getHyperlinks


putUserRole

put user roleget hyperlinks

Parameters

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

Returns promise promise [description]

getIssues


deleteUser

delete userget issues (tasks)

Parameters

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

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

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

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

Returns promise promise


getRoleDetails

get details of role

Parameters

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.

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 project

Parameters

Returns promise [description]


delete

delete the selection

Parameters

  • selectionId string selection id

Returns promise [description]Returns promise promise


share


post

post share

Parameters

  • data json share data

Returns promise promise


slides


get

get 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


delete

delete slideshow

Parameters

...

  • slideshowId string slideshow id

Returns promise promise


postThumbnail

post slideshow thumbnail

Parameters

...

Returns promise promise


structures


postStructure

post structure

Parameters

Returns promise promise


postStructureTopology

post structure topology

Parameters

...

  • structureId string structure id
  • varianttype string variant type
  • attributes boolean flag if result should contain attributesshould 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

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

...

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

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

Returns promise promise


userGroups

...


postGroup

post usergroup

Parameters

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

Returns promise [description]

postPhoto


getGroups

get groupspost user photo

Parameters

  • data [type] image dataprojectId string project id

Returns promise promise [description]

getPhoto

get user photo

Returns [type] [description]

putPassword

put (change) password

Parameters


getUsers

get users of a group

Parameters

Returns promise promise


deleteGroup

delete group

Parameters

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

Returns promise promise


users


post

post users

Parameters

  • data json [description]

...

Returns promise promise


delete

delete user

Parameters

Returns promise promise


setSubscriptions

create one or more trial account setting(s)

Parameters

Returns promise promise


userSettings

...