calculate cut
Parameters
projectId
string project idcuttingPoint
v3cuttingDirection
v3async
boolean run async flag (optional, default false
)Returns promise promise
Parameters
config
json api configpost settings
Parameters
data
json settins dataReturns promise promise
get settings
Parameters
settingId
string settings id - if not specified return all settingsReturns promise promise
put settings
Parameters
Returns promise promise
delete settings
Parameters
settingId
string settings idReturns promise promise
get attachment
Parameters
id
string atachment idReturns promise promise
download attachment
Parameters
Returns promise promise
put attachment
Parameters
Returns promise promise
post attachment
Parameters
id
[type] [description]data
[type] [description]uploadProgress
Returns promise promise
delete attachment
Parameters
Returns promise promise
post new version of the attachment
Parameters
id
[type] [description]data
[type] [description]uploadProgress
Returns promise promise
get all attachment versions
Parameters
id
string atachment idReturns promise promise
post attribute template
Parameters
data
json template dataReturns promise promise
get attribute template - if id is not specified return all attribute templates
Parameters
id
string template idReturns promise promise
put attribute template
Parameters
Returns promise promise
delete attribute template
Parameters
id
string template idReturns promise promise
post authorization
Parameters
username
string user namepassword
password passwordapplicationId
string application id - Please contact Allplan company to obtain application id !Returns promise promise
forgot password
Parameters
data
json dataReturns promise promise
check access token validity
Returns promise promise
request cross token
Returns promise promise
detect all clashes
Parameters
data
json calculation dataReturns promise promise
detect disciplines clashes
Parameters
data
json calculation dataReturns promise promise
get clash filters
Parameters
filterId
string filter id - if not specified return all filtersReturns promise promise
calculate clashes
Parameters
data
json calculation datatopology
Returns promise promise
get filter results
Parameters
Returns promise promise
createClashRule
Parameters
Returns promise promise
deleteClashRule
Parameters
ruleId
stringReturns promise promise
get all clash filters (new method)
Parameters
projectId
string project idReturns promise promise
get comments
Parameters
id
string comments idReturns promise promise
delete comment
Parameters
id
string comments idReturns promise promise
put comment
Parameters
Returns promise promise
Returns [type] [description]
get custom tables
Parameters
Returns promise promise
post custom table
Parameters
Returns promise promise
get data protection
Parameters
language
string data protection languageReturns promise promise
get element types - if id is not specified it returns all element types
Parameters
id
string element type idReturns promise promise
get element type disciplines - if id is not specified it returns all disciplines for element types
Parameters
id
string discipline idReturns promise promise
get attribute templates
Parameters
id
string element type idqueryParams
json query params e.g. { attributes : true, projectAttributeTemplate: projectAttributeTemplateId }Returns promise promise
get element types topology
Returns promise promise
get element types for project
Parameters
projectId
string project idReturns promise promise
export objects
Parameters
Returns promise promise
export model revision
Parameters
projectId
string project idmodelId
string model idrevisionNr
string revision number, if not defined, last revision is exportedReturns promise promise
private helper function to get correct url based on content property
Parameters
content
boolean flag if it is content attribute groupReturns promise promise
post free attribute group
Parameters
Returns promise promise
get free attribute group
Parameters
freeAttributeGroupId
string free attribute group idcontent
boolean flag if it is content attribute groupReturns promise promise
put free attribute group
Parameters
freeAttributeGroupId
string free attribute group iddata
json group datacontent
boolean flag if it is content attribute groupReturns promise promise
delete free attribute group
Parameters
freeAttributeGroupId
string free attribute group idcontent
boolean flag if it is content attribute groupReturns promise promise
get free attribute group
Parameters
freeAttributeGroupId
string free attribute group idcontent
boolean flag if it is content attribute groupReturns promise promise
private helper function to get correct url based on content property
Parameters
content
boolean flag if it is content attributeReturns promise promise
post free attribute
Parameters
Returns promise promise
get free attribute - if freeAttributeId is not specified return all
Parameters
freeAttributeId
string attribute idcontent
boolean flag if it is content attributequeryParams
string filter queryReturns promise promise
put free attribute
Parameters
freeAttributeId
string attribute iddata
json attribute datacontent
boolean flag if it is content attributeReturns promise promise
delete free attribute
Parameters
Returns promise promise
get free attribute topology
Parameters
content
boolean flag if it is content attributeReturns promise promise
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
get group actions rights
Returns promise promise
calculate hidden
Parameters
projectId
string project idview
json view paramsclippingPlanes
filename
string file nameasync
boolean run async flagReturns promise promise
get hyperlink
Parameters
id
string hyperlink idReturns promise promise
delete hyperlink
Parameters
id
string hyperlink idReturns promise promise
put hyperlink
Parameters
Returns promise promise
post model
Parameters
Returns promise promise
post model - land XML
Parameters
Returns promise promise
get data protection
Parameters
language
string imprints languageReturns promise promise
get invitation
Parameters
id
string invitation id, if id is null return all invitationsReturns promise promise
get all project invitation
Parameters
prjId
id
string invitation id, if id is null return all invitationsReturns promise promise
post invitation
Parameters
data
json stringified json dataReturns promise promise
delete invitation
Parameters
id
string invitation idReturns promise promise
put invitation
Parameters
Returns promise promise
accept invitation
Parameters
Returns promise promise
get invitation info
Parameters
Returns promise promise
post issue
Parameters
Returns promise promise
get issue
Parameters
id
string issue idReturns promise promise
post issue's pin
Parameters
Returns promise promise
get issue's pins
Parameters
id
string issue idReturns promise promise
delete issues pins
Parameters
id
string issue idReturns promise promise
post issue's comment
Parameters
Returns promise promise
get issues comments
Parameters
id
string issue idReturns promise promise
delete issue's comments
Parameters
id
string issue idReturns promise promise
post issue's attachment
Parameters
Returns promise promise
get issue's attachment
Parameters
id
string issue idReturns promise promise
delete issue's attachment
Parameters
id
string issue idReturns promise promise
put issue
Parameters
Returns promise promise
delete issue
Parameters
id
string issue idReturns promise promise
get issue rights
Parameters
id
string issue idReturns promise promise
get issue types
Returns promise promise
import issue from bcf
Parameters
Returns promise promise
update import bcf
Parameters
Returns promise promise
export issues in bcf format
Parameters
Returns promise promise
export issue in excel format
Parameters
Returns promise promise
lock object
Parameters
Returns promise promise
check if object is locked
Parameters
objectId
string object idReturns promise promise
delete object lock
Parameters
objectId
string object idReturns promise promise
post member
Parameters
data
json member dataReturns promise promise
get team members
Returns promise promise
put user
Parameters
Returns promise promise
delete user
Parameters
Returns promise promise
post message
Parameters
data
json message dataReturns promise promise
get user messages
Parameters
userId
string user idReturns promise promise
get user dashboard essages
Parameters
userId
string user idReturns promise promise
get messages sent by user
Parameters
userId
string user idReturns promise promise
get messages sent by user to all groups
Parameters
userId
string user idReturns promise promise
get message
Parameters
messageId
string message idReturns promise promise
get filtered messages
Parameters
filter
string filterReturns promise promise
delete message
Parameters
messageId
string message idReturns promise promise
mark message as readed
Parameters
messageId
string message idReturns promise promise
modify additionaldata part of message (title, content, messagelink and picturelink)
Parameters
Returns promise promise
adding attachment to dashboard message
Parameters
messageId
string message idadditionalData
string message additionalData (formData with set files or images(blobs))config
Returns promise promise
get all messaging groups
Returns promise promise
Get the messaging group details
Returns promise promise
get model
Parameters
modelId
string model idReturns promise promise
get head
Parameters
modelId
string model idReturns [type] [description]
Returns promise promise
get disciplines
Parameters
divisionId
string division idReturns promise promise
get revisions
Parameters
divisionId
string division idReturns promise promise
post revision
Parameters
Returns promise promise
put model
Parameters
Returns promise promise
download model
Parameters
divisionId
string division idReturns promise promise
delete model
Parameters
divisionId
string division idReturns promise promise
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
get object filters
Parameters
Returns promise promise
get filtered objects
Parameters
projectId
string project idfilterId
string filter idproperties
string propertiestopology
string topology (string) returns results organized with respect to existing topologyReturns promise promise
apply filter
Parameters
filterId
string filter idReturns promise promise
post object filter
Parameters
Returns promise promise
put object filter
Parameters
data
json object filter dataReturns promise promise
delete object filter
Parameters
id
string object filter idReturns promise promise
ger object filter info
Parameters
filterId
id
string object filter idReturns promise promise
post object
Parameters
data
json dataReturns promise promise
get object
Parameters
objectId
string object idrevision
nubmer revision numberproperties
string propertiesprojectId
string project idshortInfo
boolean true = return results without attributes and without localizedAttributeGroupsReturns promise promise
get internal
Parameters
Returns promise promise
get head
Parameters
Returns promise promise
get object topology
Parameters
objectId
string object idrevision
number revision numberhideElements
boolean hide elements flagshortInfo
boolean short info flagbatch
string Response batch id or undefined if no batching usedReturns promise promise
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 propertiesbatch
string Response batch id or undefined if no batching usedReturns promise promise
get geometry templates in three js format
Parameters
objectId
string object iddisciplineId
string discipline idchunked
boolean chunked flagrevision
number revision numberlod
string level of detailbatch
string Response batch id or undefined if no batching usedReturns promise promise
get object compressed geometry
Parameters
Returns promise promise
get object properties
Parameters
Returns promise promise
get object data
Parameters
Returns promise promise
post comment
Parameters
Returns promise promise
get object comments
Parameters
objectId
string object idReturns promise promise
delete object comments
Parameters
objectId
string object idReturns promise promise
post object attachemnt
Parameters
Returns promise promise
get object attachments
Parameters
Returns promise promise
delete all object's attachment
Parameters
objectId
string object idReturns promise promise
post object hyperlink
Parameters
Returns promise promise
get object hyperlinks
Parameters
objectId
string object idReturns promise promise
delete all object's hyperlinks
Parameters
objectId
string object idReturns promise promise
delete object
Parameters
objectId
Returns promise promise
get object attributes
Parameters
objectId
string object iddocumentVersion
number document versionprojectId
string projectId - required when resource (objectId) represents an userrevision
number revision numberReturns promise promise
get all objects of a project with existing attribute and its value
Parameters
Returns promise promise
get ComplexProperties topology for element
Parameters
Returns promise promise
post thumbnail
Parameters
Returns promise [description]
post addChildObject
Parameters
data
json 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]
get object reports
Parameters
Returns promise promise
get pins
Parameters
id
string pin idReturns promise promise
delete pin
Parameters
id
string pin idReturns promise promise
put pin
Parameters
Returns promise promise
get project action rights
Returns promise promise
post project attribute template
Parameters
data
json template dataReturns promise promise
get project attribute template - if id is not specified return all templates
Parameters
id
string template idReturns promise promise
put project template attribute
Parameters
Returns promise promise
delete project template attribute
Parameters
id
string template idReturns promise promise
copy project template attribute
Parameters
Returns promise promise
post project
Parameters
data
json project dataReturns promise promise
put project
Parameters
Returns promise promise
get project - if no id is specified return list of all projects
Parameters
id
string project idnoDisciplines
boolean flag to put disciplines in responseteamSlug
string team slug, if defined, all projects for this team slug will be loadedReturns promise [description]
delete project
Parameters
projectId
string project idReturns promise [description]
get project's models
Parameters
projectId
string project idReturns promise [description]
get all model types for given team
Returns promise [description]
get all model types for given team base on free attr information
Returns promise [description]
post model
Parameters
Returns promise [description]
get project members
Parameters
projectId
string project idReturns promise [description]
post member
Parameters
Returns promise [description]
put member
Parameters
Returns promise [description]
delete member
Parameters
Returns promise [description]
get project pins
Parameters
projectId
string project idReturns promise [description]
put project
Parameters
Returns promise [description]
post attachment
Parameters
Returns promise [description]
get attachments
Parameters
projectId
string project idrevision
number revision numberqueryParams
json json with params e.g. {projectOnly : true}Returns promise [description]
delete attachment
Parameters
projectId
string project idReturns promise [description]
get project's topology
Parameters
projectId
string project idReturns promise [description]
get spots
Parameters
projectId
string project idReturns promise [description]
post thumbnail
Parameters
Returns promise [description]
get thumbnail
Parameters
thumbnailId
string thumbnail idReturns promise [description]
get comments
Parameters
projectId
string project idReturns promise [description]
get hyperlinks
Parameters
projectId
string project idReturns promise [description]
get issues (tasks)
Parameters
projectId
string project idReturns promise [description]
get issues short info(tasks)
Parameters
projectId
string project idReturns promise [description]
post slideshow
Parameters
Returns promise [description]
get slideshows
Parameters
projectId
string project idReturns promise [description]
delete slideshows
Parameters
projectId
string project idReturns promise [description]
get project info
Parameters
projectId
string project idReturns promise promise
post revision
Parameters
Returns promise promise
get revisions list
Parameters
id
string division (model) idReturns promise promise
get revision info
Parameters
id
string revision idReturns promise promise
put revision info
Parameters
Returns promise promise
get revision comparision result
Parameters
id
string division (model) idrevisionNumber1
number revision number 1revisionNumber2
number revision number 2queryParams
Returns promise promise
compare revisions
Parameters
id
string division(model) idrevisionNumber1
number revision number 1revisionNumber2
number revision number 2queryParams
Returns promise promise
get right roles
Parameters
projectId
string project id - if not specified return all rolesReturns promise promise
post user role
Parameters
Returns promise promise
put user role
Parameters
Returns promise promise
delete user
Parameters
projectId
string project id - if not specified return all rolesReturns promise promise
get roles
Parameters
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.
get all rights
Parameters
filter
JSON { globalfreeattributes:true/false global:true/false, project:true/false, document:true/false, layer:true/false }Returns promise promise
create new role
Parameters
newRole
jsonReturns 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" > > <<
delete existing role
Parameters
roleId
stringReturns promise promise
get details of role
Parameters
roleId
stringReturns promise promise
update existing role
Parameters
Returns promise promise
Creates a new selection object. The structure of the Selection objects is the same like the structure of the Export Object Selection.
Parameters
Returns promise promise
get selection object details
Parameters
selectionId
string selection idReturns promise [description]
get all selections of the project
Parameters
projectId
string selection idReturns promise [description]
delete the selection
Parameters
selectionId
string selection idReturns promise [description]
post share
Parameters
data
json share dataReturns promise promise
get slide
Parameters
slideId
string slide idReturns promise promise
put slide
Parameters
Returns promise promise
delete slide
Parameters
slideId
string slide idReturns promise promise
post thumbnail
Parameters
Returns promise promise
get slideshow
Parameters
slideshowId
string slideshow idReturns promise promise
put slideshow
Parameters
Returns promise promise
delete slideshow
Parameters
slideshowId
string slideshow idReturns promise promise
post slide
Parameters
Returns promise promise
get slides
Parameters
slideshowId
string slideshow idReturns promise promise
post slideshow thumbnail
Parameters
Returns promise promise
get slideshow thumbnail
Parameters
thumbnailId
string thumbnail idReturns promise promise
post structure
Parameters
Returns promise promise
post structure topology
Parameters
Returns promise promise
post sub node
Parameters
Returns promise promise
post assigned object - assign object to structure
Parameters
structureId
string structure idobjectId
string object idvarianttype
string variant typedata
json dataReturns promise promise
assign attribute to structure
Parameters
projectId
string project idstructureId
string structure idattributeId
string attribute idvarianttype
string variant typeReturns promise promise
delete assigned object from structure
Parameters
Returns promise promise
get structure - is structure id is empty return all structures with specific type
Parameters
Returns promise promise
get structure topology
Parameters
structureId
string structure idvarianttype
string variant typeattributes
boolean flag if result should contain attributesReturns promise promise
get toplogy structure
Parameters
projectId
[type] [description]Returns promise promise
create or reset toplogy structure
Parameters
projectId
[type] [description]Returns promise promise
copy structure
Parameters
Returns promise promise
put structure
Parameters
Returns promise promise
reorder structure
Parameters
Returns promise promise
delete structure
Parameters
structureId
string structure idReturns promise promise
delete all project structures
Parameters
projectId
string project idReturns promise promise
post variant type
Parameters
Returns promise promise
get variant type
Parameters
Returns promise promise
delete variant type
Parameters
Returns promise promise
copy elements to variant
Parameters
projectId
string project idvarianttype
string variant typevariant
json json string with variant dataReturns promise promise
get team action rights
Returns promise promise
get team data if id is not specified return list of teams
Parameters
id
string team id - if not specified return list of teamsReturns promise promise
post team
Parameters
data
json team dataReturns promise promise
put team
Parameters
Returns promise promise
delete team
Parameters
teamId
string team idReturns promise promise
get team account settings
Parameters
teamId
string team idReturns promise promise
get team restrictions
Parameters
teamId
string team idReturns promise promise
get terms
Parameters
language
string terms languageReturns promise promise
post units
Parameters
data
json units dataReturns promise promise
get unit - if id is not specified return all units
Parameters
unitId
string unit idReturns promise promise
put unit
Parameters
Returns promise promise
delete unit
Parameters
unitId
string unit idReturns promise promise
get user
Parameters
token
[type] [description]Returns promise [description]
put
Parameters
userId
[type] [description]data
[type] [description]token
[type] [description]Returns promise promise
post user
Parameters
data
[type] [description]Returns promise [description]
post user photo
Parameters
data
[type] image dataReturns promise [description]
get user photo
Returns [type] [description]
put (change) password
Parameters
data
[type] [description]Returns promise promise
get user subscriptions
Parameters
id
string user idReturns promise promise
post group
Parameters
Returns promise [description]
get groups
Parameters
projectId
string project idReturns promise promise
get users of a group
Parameters
groupId
string group idReturns promise promise
delete group
Parameters
groupId
string group idReturns promise promise
put group
Parameters
Returns promise promise
assign user to a group or change group role
Parameters
Returns promise promise
post users
Parameters
data
json [description]Returns promise promise
check if user exists
Parameters
email
string user emailReturns promise promise
put user
Parameters
userId
string user iddata
Returns promise promise
delete user
Parameters
userId
string user idReturns promise promise
create one or more trial account setting(s)
Parameters
Returns promise promise
post settings
Parameters
Returns promise promise
get settings
Parameters
category
string key of user settingsReturns promise promise