This web page is under construction. The JSON Request and Reply (Request and Reply tab) for the API calls are not complete.
Service available !
POST
Resource: projects
URL: https://api.bimplus.net/v2/<team>/projects
Example: https://api.bimplus.net/v2/bimplus/projects
JSON Structure:
Name
Mandatory / Optional
Type
Description
name
optional
string
Name of the project
shortDescr
Short description of the project
created
date
Creation date of the project
Creates a new project.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
{ "name:" : "Your Awesome Building", "shortDescr" : "Example for creating a project" }
Status: 201 Created
{ name: null shortDescr: "Example for creating a project" thumbnail: null created: "2013-06-01T10:05:00" changed: null disciplines: null id: "ee1ef597-33b2-4037-865e-bc4e26deacca" }
GET
Gets the available project list with main properties.
Status: 200 OK
[3] 0: { id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff" name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang" }- 1: { id: "2d703abe-b4f9-407c-af53-a39c5b7ba872" name: "__5 999 Parklife Salzburg Lehen" }- 2: { id: "c480cc54-aec4-4bef-8d35-93bb090e1aba" name: "0811-Wohnhaus Kraus - Carport1" }
Resource: projects/<project_id>
URL: https://api.bimplus.net/v2/<team>/projects/<project_id>
Example: https://api.bimplus.net/v2/bimplus/projects/c8c8e6f2-4495-484c-929d-0049f1f9d4ff
Get all the project properties of a project using its id.
{ disciplines: [0] name: null shortDescr: null thumbnail: null created: "0001-01-01T00:00:00" changed: "0001-01-01T00:00:00" id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff" }
PUT
URL: https://api.bimplus.net/v2/<company>/projects/<project_id>
id
mandatory
guid
id of the project
changed
Changed date of the project
Update or replace a specified existing project with a new one.
Resource: projects/<project_id>issues
URL: https://api.bimplus.net/v2/<company>/projects/<project_id>/issues
projectId
Id of the project
Name of the issue
description
Description of the issue
author
Author of the issue
status
Status of the issue
createdAt
Creation date of the issue
dueDate
The date in which the issue is planned to be finished
solution
classification
priority
Creates a new issue in a project.
Get all the issues assigned to a specified project.
DELETE
Resource: projects/<project_id>issues URL: https://api.bimplus.net/v2/<company>/projects/<project_id>/issues Example: https://api.bimplus.net/v2/bimplus/projects
Delete all the issues belonging to a specified project.
Resource: projects/<project_id>/attachments
URL: https://api.bimplus.net/v2/<company>/projects/<project_id>/attachments
objectIds
The id of the project objects to which the file has to be attached
fileName
Name of the file to be attached to the project
type
Mime type
size
long
Size of the file to be attached to the project
Creates a new attachment in a project.
Get all the attachments belonging to a specified project.
Delete all the attachments belonging to a specified project.
Resource: projects/<project_id>/disciplines
URL: https://api.bimplus.net/v2/<company>/projects/<project_id>/disciplines
Get the disciplines of a project.
Resource: projects/<project_id> URL: https://api.bimplus.net/v2/<company>/projects/<project_id>
Deletes a specified project.
Resource: objects
URL: https://api.bimplus.net/v2/<company>/objects
parent
The id of the parent to which the object can be associated
Element type of the object
attributes
Attributes of the object
children
Children of the object
Creates a new object
Resource: objects/<object_id>
URL: https://api.bimplus.net/v2/<company>/objects/<object_id>
Get the object tree with full property list whose geometry type is "mesh"(default)
Resource: objects/<object_id>/nogeometry
URL: https://api.bimplus.net/v2/<company>/objects/<object_id>/nogeometry
Get the full property list of the object without geometry
Resource: objects/<object_id>/projecttree
URL: https://api.bimplus.net/v2/<company>/objects/<object_id>/projecttree
Get the project topology tree.
Resource: objects/<object_id>/topology
URL: https://api.bimplus.net/v2/<company>/objects/<object_id>/topology
Get the object tree with full property list without geometry.
Resource: objects/<object_id>/geometries/threejs
URL: https://api.bimplus.net/v2/<company>/objects/<object_id>/geometries/threejs
Get the optimized objects tree with selected property list whose geometry type is "ThreeJS".
Resource: objects/<object_id>/geometries/meshblob
URL: https://api.bimplus.net/v2/<company>/objects/<object_id>/geometries/meshblob
Get the object tree with full property list whose geometry type is "compressed geometry mesh (meshblob)".
Resource: objects/<object_id>/disciplines/<discipline_id>/geometries/threejs
URL: https://api.bimplus.net/v2/<company>/objects/<object_id>/disciplines/<discipline_id>/geometries/threejs
Get the object tree with selected property list whose geometry type is "ThreeJS" filtered by discipline.
Resource: objects/<object_id>/disciplines/<discipline_id>/geometries/meshblob
URL: https://api.bimplus.net/v2/<company>/projects
Get the object tree whose geometry type is "compressed geometry mesh (meshblob)" filtered by discipline.
Id of the object
Update or replace a specified existing object with a new one.
Resource: objects/<object_id>attachments
URL: https://api.bimplus.net/v2/<company>/objects/<object_id>attachments
The id of the objects to which the file has to be attached
Create a new attachment in a object.
Get all the attachments belonging to a specified object.
Resource: objects/<object_id>/attachments
URL: https://api.bimplus.net/v2/<company>/objects/<object_id>/attachments
Delete all the attachments from a specified project.
Deletes a specified object.
Resource: element-types
URL: https://api.bimplus.net/v2/<team>/element-types
Example: https://api.bimplus.net/v2/bimplus/element-types
Gets the list of existing element types.
[3] 0: [3] 0: { type: "GeometryObject" category: "/1/30/4/" name: "3D object" ifcType: "ID_IFCBuildingElementProxy" id: "5a8a8670-cb9f-4f04-a467-04a9e416a6d0" }- 1: { type: "Chimney" category: "/1/10/8/" name: "Chimney" ifcType: "ID_IFCBuildingElementProxy" id: "e504f24c-e643-452b-b901-6a18883dc7e9" }- 2: { type: "Column" category: "/1/10/2/" name: "Column" ifcType: "ID_IFCColumn" id: "2e308afe-d078-4c20-b53c-76b2da66d848" }
Resource: element-types/<element_type_id>
URL: https://api.bimplus.net/v2/<team>/element-types/<element_id>
Example: https://api.bimplus.net/v2/bimplus/element-types/e504f24c-e643-452b-b901-6a18883dc7e9
Get the properties of a specified element type.
{ type: "Chimney" category: "/1/10/8/" name: "Chimney" ifcType: "ID_IFCBuildingElementProxy" id: "e504f24c-e643-452b-b901-6a18883dc7e9" }
Resource: element-types/disciplines
URL: https://api.bimplus.net/v2/<team>/element-types/disciplines
Example: https://api.bimplus.net/v2/bimplus/element-types/disciplines
Gets the list of existing disciplines.
{ -e79a4e18-383f-49c4-aabf-e15b27850423: { category: "/14/" name: "Airconditionermodel" ifcType: null id: "e79a4e18-383f-49c4-aabf-e15b27850423" } -63b069d2-81df-4418-91de-8a954fa12924: { category: "/5/" name: "Wood Construction Model" ifcType: null id: "63b069d2-81df-4418-91de-8a954fa12924" } -dd5cc7d0-72fe-46aa-ba62-dcd86729bd2f: { category: "/4/" name: "Massiveconstructionmodel" ifcType: null id: "dd5cc7d0-72fe-46aa-ba62-dcd86729bd2f" } -6a6e4d09-3550-4483-8134-98ac1e6c1afb: { category: "/60/" name: "Production model" ifcType: null id: "6a6e4d09-3550-4483-8134-98ac1e6c1afb" } -09e623d4-1e12-4a77-b358-ea1d0b28e4a7: { category: "/2/" name: "Roommodel" ifcType: null id: "09e623d4-1e12-4a77-b358-ea1d0b28e4a7" } -687c6451-3fa1-47e0-9f13-406833bb06f3: { category: "/13/" name: "TGA_Wastewatermodel" ifcType: null id: "687c6451-3fa1-47e0-9f13-406833bb06f3" } }
Not used in the current edition!
Resource: attachments/<attachment_id>
URL: https://api.bimplus.net/v2/<company>/attachments/<attachment_id>
Get detailed information about a specified attachment.
Resource: attachments/<attachment_id>/download
URL: https://api.bimplus.net/v2/<company>/attachments/<attachment_id>/download
Download the content of a specified attachment.
Service not finished yet !
Update or replace a specified existing attachment with a new one.
Deletes a specified attachment.
Resource: issues/<issue_id>
URL: https://api.bimplus.net/v2/<company>/issues/<issue_id>
Get details of an issue present in a project.
Resource: issues/types
URL: https://api.bimplus.net/v2/<company>/issues/types
Get all the available issue types.
Resource: issues/types/<type_id>
URL: https://api.bimplus.net/v2/<company>/issues/types/<type_id>
Get details of a specified issue type.
Resource: issues/<issue_id>/pins
issueId
The id of the issue to which the pin is related
objectId
The id of the object to which the pin is related
position
normalVector
The creation date
Create a new pin for an issue for relating the issue with its object.
URL: https://api.bimplus.net/v2/<company>/issues/<issue_id>/pins
Get all the pins of a specified issue type.
Delete all the pins from a specified issue.
Resource: issues/<issue_id>/comments
URL: https://api.bimplus.net/v2/<company>/issues/<issue_id>/comments
Create a new comment for a specified issue.
Get all the comments of a specified issue.
Resource: issues/<issue_id>/comments/<comment_id>
URL: https://api.bimplus.net/v2/<company>/issues/<issue_id>/comments/<comment_id>
Deletes a specified comment.
Resource: issues/<issue_id>/attachments
URL: https://api.bimplus.net/v2/<company>/issues/<issue_id>/attachments
The id of the issue objects to which the file has to be attached
Creates a new attachment for a specified issue.
Gets the attachment list from a specified issue.
Delete all the attachments from a specified issue.
Update or replace a specified existing issue with a new one.
Deletes a specified issue.
Resource: pins/<pin_id>
URL: https://api.bimplus.net/v2/<company>/pins/<pin_id>
Get details of a specified pin.
Update or replace a specified existing pin with a new one.
Deletes a specified pin.
Resource: import
URL: https://api.bimplus.net/v2/<company>/import
Create a new project by importing SketchUp and IFC files into the team database.
Resource: projects/<project_id>/import
URL: https://api.bimplus.net/v2/<company>/projects/<project_id>/import
Create a new sub-project by importing SketchUp and IFC files into the project.
Resource: authorize
URL: https://api.bimplus.net/v2/<company>/authorize
Authenticate by requesting and receiving a token.
Resource: tokeninfo?access_token=<token>
URL: https://api.bimplus.net/v2/<company>/tokeninfo?access_token=<token>
Get information about a specified token.
Resource: revoke?token=<token>
URL: https://api.bimplus.net/v2/<company>/revoke?token=<token>
The specified token will expire immediately.
Resource: users
URL: https://api.bimplus.net/v2/<company>/users
Creates a new user account.
Resource: users/<user_id>
URL: https://api.bimplus.net/v2/<company>/users/<user_id>
Get information about a specified user.
Update information about a specified user.
Resource: user
URL: https://api.bimplus.net/v2/<company>/user
Get information about the currently logged in user.
Resource: teams
URL: https://api.bimplus.net/v2/<company>/teams
Id of the team
slug
The unique name which will be used in the url
Name of the team
owner
The unique identifier of the user who will be the initial owner
totalStorage
The total storage allocated to the the team
storageStats
The storage statistics of the team
teamWorksConnection
dataStorageStatus
Create a new team and its related database.
Resource: teams/<team_id>
URL: https://api.bimplus.net/v2/<company>/teams/<team_id>
Get information about a specified team.
Update information about a specified team.
Get a team list in which the current logged in user is a member of
Resource: <team_id>/members
URL: https://api.bimplus.net/v2/<company>/<team_id>/members
Add a specified user to a specified team.
Resource: <team_id>/members/<user_id>
URL: https://api.bimplus.net/v2/<company>/<team_id>/members/<user_id>
Update information about a specified user in a team.
Deletes a specified user from a team.
test for null