View Source

Help us improve the Bimplus API doc by providing your valuable comments. You can find the comment section at the bottom of the page.

Please use for the testing purposes because our productive server is not available to the market yet.

Project relevant services

Administration relevant services

Project Service

Object Service

ElementType Service

Authorization Service

User Management Service

Team Management Service

Membership Management Service

Project Service

A Project is basically a building project which can be created or imported into the Bimplus platform using the appropriate Bimplus services.

Please use the Bimplus Import Service for importing the existing projects

Create a new project

POST

Resource: projects

URL: https://api.bimplus.net/v2/<team_slug>/projects

Example: https://api.bimplus.net/v2/bimplus/projects

JSON Structure:

Name	Mandatory / Optional	Type	Description
name	optional	string	Name of the project
shortDescr	optional	string	Short description of the project
created	will be ignored	string (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": "Your Awesome Building",
"shortDescr": "Example for creating a project",
"thumbnail": null,
"created": "2013-06-01T10:05:00",
"changed": null,
"disciplines": null,
"id": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
}

Get the Project List

GET

Resource: projects

URL: https://api.bimplus.net/v2/<team_slug>/projects

Example: https://api.bimplus.net/v2/bimplus/projects

Gets the available project list with main properties.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Status: 200 OK

[
    {
        "id": "586b02be-43b8-4e27-b698-e067e85e38e2",
        "name": "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang",
        "shortDescr": "Hey, i am your favourite test entry",
        "thumbnail": null,
        "created": "2013-05-01T09:33:18",
        "changed": "2013-05-01T09:33:18"
    },
    {
        "id": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
        "name": "Your Awesome Building",
        "shortDescr": "Example for creating a project",
        "thumbnail": null,
        "created": "0001-01-01T00:00:00",
        "changed": "0001-01-01T00:00:00"
    },
    {
        "id": "4e87944a-a477-4e4c-862e-e723dcb43066",
        "name": "UC_Fly-over Kerensheide",
        "shortDescr": null,
        "thumbnail": null,
        "created": "2013-05-10T07:13:38",
        "changed": "2013-05-16T07:34:56"
    }
]

Get the Project Properties

GET

Resource: projects/<project_id>

URL: https://api.bimplus.net/v2/<team_slug>/projects/<project_id>

Example: https://api.bimplus.net/v2/bimplus/projects/586b02be-43b8-4e27-b698-e067e85e38e2

Get all the project properties of a project using its id.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Status: 200 OK

{
    "name": "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang",
    "shortDescr": "Hey, i am your favourite test entry",
    "thumbnail": null,
    "created": null,
    "changed": null,
    "disciplines": [
        {
            "id": "0f106af0-a919-44c5-b211-15bd5ef620b6",
            "name": "ID_BuildingModel",
            "divisionId": "ac21b9a1-8853-4658-9fbf-0cf62340bd18",
            "divisionName": null,
            "revisions": []
        },
        {
            "id": "63b069d2-81df-4418-91de-8a954fa12924",
            "name": "ID_DesignModel_Timber",
            "divisionId": "ac21b9a1-8853-4658-9fbf-0cf62340bd18",
            "divisionName": null,
            "revisions": []
        },
        {
            "id": "30114b52-bc05-47c1-80b5-c7d5485d5840",
            "name": "ID_FinishModel",
            "divisionId": "ac21b9a1-8853-4658-9fbf-0cf62340bd18",
            "divisionName": null,
            "revisions": []
        },
        {
            "id": "09e623d4-1e12-4a77-b358-ea1d0b28e4a7",
            "name": "ID_RoomModel",
            "divisionId": "ac21b9a1-8853-4658-9fbf-0cf62340bd18",
            "divisionName": null,
            "revisions": []
        }
    ],
    "id": "586b02be-43b8-4e27-b698-e067e85e38e2"
}

Update the project

PUT

Resource: projects/<project_id>

URL: https://api.bimplus.net/v2/<team_slug>/projects/<project_id>

Example: https://api.bimplus.net/v2/bimplus/projects/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e

JSON Structure:

Name	Mandatory / Optional	Type	Description
name	optional	string	Name of the project
shortDescr	optional	string	Short description of the project
created	will be ignored	string (date)	Creation date of the project
changed	will be ignored	string (date)	Changed date of the project

Update or replace a specified existing project with a new one.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

{
    "properties": {
        "MainFloorArea": "456m²",
        "Architect": {
            "name": "NemetschekTech.GmbH",
            "phone1": "089/12793-1115",
            "phone2": "0171/71384483",
            "email": "MyName@Nemetschek.com",
            "city": "Munich",
            "zip": "81829",
            "street": "Konrad-Zuse-Platz1"
        },
        "Customer": {
            "name": "Bimplus customer",
            "phone1": "001-201-1279345",
            "email": "MyName@Nemetschek.com",
            "city": "New Jersy",
            "zip": "08201"
        }
    }
}

Status: 200 OK

Create an issue in the project

POST

Resource: projects/<project_id>issues

URL: https://api.bimplus.net/v2/<team_slug>/projects/<project_id>/issues

Example: https://api.bimplus.net/v2/bimplus/projects/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e/issues

JSON Structure:

Name	Mandatory / Optional	Type	Description
projectId	will be ignored	string (guid)	Id of the project
name	optional	string	Name of the issue
description	optional	string	Description of the issue
author	optional	string	Author of the issue
status	optional	string	Status of the issue
createdAt	will be ignored	string (date)	Creation date of the issue
dueDate	optional	string (date)	The date in which the issue is planned to be finished
solution	optional	string	The proposed solution for the issue
classification	optional	string	The classification to which the issues belongs
priority	optional	string	The priority of the issue

Creates a new issue in a project.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

{
"name": "Fire Exit Wrong",
"description": "The fire exit is in the wrong place",
"author": "Mr. Smart",
"status": "open",
"dueDate": "2013-06-05T10:05:00",
"classification": "",
"priority": "very high"
}

Status: 201 Created

{
    "projectId": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
    "name": "Fire Exit Wrong",
    "description": "The fire exit is in the wrong place",
    "author": "Mr. Smart",
    "status": "open",
    "createdAt": "2013-06-02T10:05:00+00:00",
    "dueDate": "2013-06-05T10:05:00+00:00",
    "solution": null,
    "classification": "",
    "priority": "very high",
    "revision": null,
    "id": "8ead8bfe-ab23-4340-ac47-38181e83bff3"
}

Get the Issue List from the project

GET

Resource: projects/<project_id>issues

URL: https://api.bimplus.net/v2/<team_slug>/projects/<project_id>/issues

Example: https://api.bimplus.net/v2/bimplus/projects/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e/issues

Get all the issues assigned to a specified project.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Status: 200 OK

[
    {
        "projectId": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
        "name": "Fire Exit Wrong",
        "description": "The fire exit is in the wrong place",
        "author": "Mr. Smart",
        "status": "open",
        "createdAt": "2013-06-02T10:05:00+00:00",
        "dueDate": "2013-06-05T10:05:00+00:00",
        "solution": null,
        "classification": "",
        "priority": "very high",
        "revision": null,
        "id": "8ead8bfe-ab23-4340-ac47-38181e83bff3"
    },
    {
        "projectId": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
        "name": "Geometry information missing for wall",
        "description": "The geometry information is missing for the wall in the kitchen",
        "author": "Mr. Architect",
        "status": "open",
        "createdAt": "2013-06-02T10:05:00+00:00",
        "dueDate": "2013-06-05T10:05:00+00:00",
        "solution": null,
        "classification": "",
        "priority": "high",
        "revision": null,
        "id": "a171bc90-b03f-4ddd-9794-cf77f424f4e2"
    }
]

Delete all the issues from the project

DELETE

Resource: projects/<project_id>issues

URL: https://api.bimplus.net/v2/<team_slug>/projects/<project_id>/issues

Example: https://api.bimplus.net/v2/bimplus/projects/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e/issues

Delete all the issues belonging to a specified project.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Status: 200 OK

Create a new attachment in the project

POST

Resource: projects/<project_id>/attachments

URL: https://api.bimplus.net/v2/<team_slug>/projects/<project_id>/attachments

Example: https://api.bimplus.net/v2/bimplus/projects/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e/attachments

JSON Structure: Please note that all the information required for this call will be taken from the document that you attach and hence the request of this call has no body.

Name	Mandatory / Optional	Type	Description
objectIds	will be ignored	string	The id of the project objects to which the file has to be attached
fileName	will be ignored	string	Name of the file to be attached to the project
type	will be ignored	string	Mime type
size	will be ignored	integer	Size of the file to be attached to the project

Creates a new attachment in a project.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: multipart/form-data

Status: 201 Created

[
    {
        "objectIds": [
            "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
        ],
        "fileName": "Building_Plan.jpg",
        "type": "image/jpeg",
        "size": 211258,
        "id": "6cea110a-88f4-43ac-9a00-ebaf677be333"
    }
]

Get the Attachment List from the project

GET

Resource: projects/<project_id>/attachments

URL: https://api.bimplus.net/v2/<team_slug>/projects/<project_id>/attachments

Example: https://api.bimplus.net/v2/bimplus/projects/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e/attachments

Get all the attachments belonging to a specified project.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Status: 200 OK

[
    {
        "objectIds": [
            "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
        ],
        "fileName": "Building_Plan.jpg",
        "type": "image/jpeg",
        "size": 211258,
        "id": "6cea110a-88f4-43ac-9a00-ebaf677be333"
    }
]

Delete all the attachments from the project

DELETE

Resource: projects/<project_id>/attachments

URL: https://api.bimplus.net/v2/<team_slug>/projects/<project_id>/attachments

Example: https://api.bimplus.net/v2/bimplus/projects/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e/attachments

Delete all the attachments belonging to a specified project.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Status: 200 OK

Get the project topology tree

GET

Resource: projects/<project_id>/topology

URL: https://api.bimplus.net/v2/<team_slug>/projects/<project_id>/topology

Example: https://api.bimplus.net/v2/bimplus/projects/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e/topology

Get the project topology tree.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Status: 200 OK

{
    "parent": null,
    "name": null,
    "type": "Project",
    "children": [
        {
            "parent": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
            "name": null,
            "type": "ID_TopologyDivision",
            "children": [],
            "id": "195db084-3715-4ebc-b164-3ee47a495b2e"
        }
    ],
    "id": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
}

Get the project layers

GET

Resource: projects/<project_id>/disciplines

URL: https://api.bimplus.net/v2/<team_slug>/projects/<project_id>/disciplines

Example: https://api.bimplus.net/v2/bimplus/projects/586b02be-43b8-4e27-b698-e067e85e38e2/disciplines

Get the layers of a project.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Status: 200 OK

[
    {
        "id": "0f106af0-a919-44c5-b211-15bd5ef620b6",
        "name": "ID_BuildingModel",
        "divisionId": "ac21b9a1-8853-4658-9fbf-0cf62340bd18",
        "divisionName": null,
        "revisions": []
    },
    {
        "id": "63b069d2-81df-4418-91de-8a954fa12924",
        "name": "ID_DesignModel_Timber",
        "divisionId": "ac21b9a1-8853-4658-9fbf-0cf62340bd18",
        "divisionName": null,
        "revisions": []
    },
    {
        "id": "30114b52-bc05-47c1-80b5-c7d5485d5840",
        "name": "ID_FinishModel",
        "divisionId": "ac21b9a1-8853-4658-9fbf-0cf62340bd18",
        "divisionName": null,
        "revisions": []
    },
    {
        "id": "09e623d4-1e12-4a77-b358-ea1d0b28e4a7",
        "name": "ID_RoomModel",
        "divisionId": "ac21b9a1-8853-4658-9fbf-0cf62340bd18",
        "divisionName": null,
        "revisions": []
    }
]

Create / Upload a thumbnail to the project

POST

Resource: projects/<project_id>/thumbnail

URL: https://api.bimplus.net/v2/<team_slug>/projects/<project_id>/thumbnail

Example: https://api.bimplus.net/v2/bimplus/projects/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e/thumbnail

Creates or uploads a thumbnail to the project.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: multipart/form-data

Thumbnail API call:

Status: 201 Created

{
fileName: "MyThumbnail.jpg"
type: "image/jpeg"
size: 5262
id: "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
}

Download the thumbnail

GET

Resource: projects/<project_id>/thumbnail/download

URL: https://api.bimplus.net/v2/<team_slug>/projects/<project_id>/thumbnail/download

Example: https://api.bimplus.net/v2/bimplus/projects/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e/thumbnail/download

Downloads the thumbnail.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: multipart/form-data

Status: 200 OK

Delete the project

DELETE

Resource: projects/<project_id>

URL: https://api.bimplus.net/v2/<team_slug>/projects/<project_id>

Example: https://api.bimplus.net/v2/bimplus/projects/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e

Deletes a specified project.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Status: 200 OK

Object Service

Objects are the primary component of the project tree and it exists in two forms.

Node: Objects with no graphical representation
Geometry: Objects with graphical representation (See Geometry)

Please see the detailed structure of the issue in the Object Model

Create a new object

POST

Resource: objects

URL: https://api.bimplus.net/v2/<team_slug>/objects

Example: https://api.bimplus.net/v2/bimplus/objects

JSON Structure:

Name	Mandatory / Optional	Type	Description
parent	optional	string (guid)	The id of the parent to which the object can be associated
type	mandatory	string	Element type of the object
attributes	optional	string	Attributes of the object
children	optional	Object	Children of the object

Creates a new object

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

{
    "parent": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
    "type": "Wall",
    "attributes": {
        "element": {
            "isparent": false,
            "nr": 0,
            "matrix": "AAAAAAAA8D8AAAAAAAAAgAAAAAAAAACAINejcP1YsEAAAAAAAAAAgAAAAAAAAPA/AAAAAAAAAIAK16Nw/fy2QAAAAAAAAACAAAAAAAAAAIAAAAAAAADwPwAArkfheoS/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8=",
            "elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
            "divisionid": "ac21b9a1-8853-4658-9fbf-0cf62340bd18"
        },
        "general": {
            "name": "Brickwall",
            "isobjectvalid": true
        },
        "quantity": {
            "width": 115
        },
        "allplan": {
            "allplan_guid": "08b8195a-a2ad-11e2-9993-002215ea7d6b",
            "allplan_id": 2065507287,
            "allplan_text": "<PP>Wall",
            "dateofexport": "2013-05-01T09:32:13"
        },
        "geometry": {
            "mesh": "{\"C\":4278255360,\"V\":[4450.01,115.01,0.01,3200.01,115.01,0.01,3200.01,0.01,0.01,4450.01,0.01,0.01,2315.01,0.01,0.01,2315.01,115.01,0.01,0.01,115.01,0.01,0.01,0.01,0.01,4450.01,115.01,2750.01,4450.01,0.01,2750.01,0.01,0.01,2750.01,0.01,115.01,2750.01,2315.01,115.01,2190.01,3200.01,115.01,2190.01,3200.01,0.01,2190.01,2315.01,0.01,2190.01],\"F\":[4,0,1,2,3,4,4,5,6,7,4,8,9,10,11,4,0,3,9,8,8,6,5,12,13,1,0,8,11,4,7,6,11,10,8,3,2,14,15,4,7,10,9,4,12,15,14,13,4,15,12,5,4,4,13,14,2,1]}"
        }
    }
}

Status: 201 Created

{
    "id": "7cf910cb-e357-43f6-aa3a-b45c26380f75",
    "parent": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
    "type": "Wall",
    "attributes": {
        "element": {
            "isparent": false,
            "nr": 0,
            "matrix": "AAAAAAAA8D8AAAAAAAAAgAAAAAAAAACAINejcP1YsEAAAAAAAAAAgAAAAAAAAPA/AAAAAAAAAIAK16Nw/fy2QAAAAAAAAACAAAAAAAAAAIAAAAAAAADwPwAArkfheoS/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8=",
            "elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
            "divisionid": "ac21b9a1-8853-4658-9fbf-0cf62340bd18"
        },
        "general": {
            "name": "Brickwall",
            "isobjectvalid": true
        },
        "quantity": {
            "width": 115
        },
        "allplan": {
            "allplan_guid": "08b8195a-a2ad-11e2-9993-002215ea7d6b",
            "allplan_id": 2065507287,
            "allplan_text": "<PP>Wall",
            "dateofexport": "2013-05-01T09:32:13"
        },
        "geometry": {
            "mesh": "{\"C\":4278255360,\"V\":[4450.01,115.01,0.01,3200.01,115.01,0.01,3200.01,0.01,0.01,4450.01,0.01,0.01,2315.01,0.01,0.01,2315.01,115.01,0.01,0.01,115.01,0.01,0.01,0.01,0.01,4450.01,115.01,2750.01,4450.01,0.01,2750.01,0.01,0.01,2750.01,0.01,115.01,2750.01,2315.01,115.01,2190.01,3200.01,115.01,2190.01,3200.01,0.01,2190.01,2315.01,0.01,2190.01],\"F\":[4,0,1,2,3,4,4,5,6,7,4,8,9,10,11,4,0,3,9,8,8,6,5,12,13,1,0,8,11,4,7,6,11,10,8,3,2,14,15,4,7,10,9,4,12,15,14,13,4,15,12,5,4,4,13,14,2,1]}"
        }
    }
}

Get the object details

GET

Resource: objects/<object_id>

URL: https://api.bimplus.net/v2/<team_slug>/objects/<object_id>

Example: https://api.bimplus.net/v2/bimplus/objects/7cf910cb-e357-43f6-aa3a-b45c26380f75

Gets the details of an object

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Status: 200 OK

{
    "id": "7cf910cb-e357-43f6-aa3a-b45c26380f75",
    "type": "Wall",
    "attributes": {
        "element": {
            "isparent": false,
            "nr": 0,
            "matrix": "AAAAAAAA8D8AAAAAAAAAgAAAAAAAAACAINejcP1YsEAAAAAAAAAAgAAAAAAAAPA/AAAAAAAAAIAK16Nw/fy2QAAAAAAAAACAAAAAAAAAAIAAAAAAAADwPwAArkfheoS/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8=",
            "elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
            "logparentid": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
            "divisionid": "ac21b9a1-8853-4658-9fbf-0cf62340bd18"
        },
        "general": {
            "name": "Brickwall",
            "isobjectvalid": true
        },
        "allplan": {
            "allplan_guid": "08b8195a-a2ad-11e2-9993-002215ea7d6b",
            "allplan_id": 2065507287,
            "allplan_text": "<PP>Wall",
            "dateofexport": "2013-05-01T09:32:13"
        },
        "geometry": {
            "mesh": "{\"C\":0,\"V\":[4450.01,115.01,0.01,3200.01,115.01,0.01,3200.01,0.01,0.01,4450.01,0.01,0.01,2315.01,0.01,0.01,2315.01,115.01,0.01,0.01,115.01,0.01,0.01,0.01,0.01,4450.01,115.01,2750.01,4450.01,0.01,2750.01,0.01,0.01,2750.01,0.01,115.01,2750.01,2315.01,115.01,2190.01,3200.01,115.01,2190.01,3200.01,0.01,2190.01,2315.01,0.01,2190.01],\"F\":[4,0,1,2,3,4,4,5,6,7,4,8,9,10,11,4,0,3,9,8,8,6,5,12,13,1,0,8,11,4,7,6,11,10,8,3,2,14,15,4,7,10,9,4,12,15,14,13,4,15,12,5,4,4,13,14,2,1]}"
        }
    }
}

Get the full property list of the object without geometry

GET

Resource: objects/<object_id>/nogeometry

URL: https://api.bimplus.net/v2/<team_slug>/objects/<object_id>/nogeometry

Example: https://api.bimplus.net/v2/bimplus/objects/7cf910cb-e357-43f6-aa3a-b45c26380f75/nogeometry

Get the full property list of the object without geometry

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Status: 200 OK

{
    "id": "7cf910cb-e357-43f6-aa3a-b45c26380f75",
    "type": "Wall",
    "attributes": {
        "element": {
            "isparent": false,
            "nr": 0,
            "matrix": "AAAAAAAA8D8AAAAAAAAAgAAAAAAAAACAINejcP1YsEAAAAAAAAAAgAAAAAAAAPA/AAAAAAAAAIAK16Nw/fy2QAAAAAAAAACAAAAAAAAAAIAAAAAAAADwPwAArkfheoS/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8=",
            "elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
            "logparentid": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
            "divisionid": "ac21b9a1-8853-4658-9fbf-0cf62340bd18"
        },
        "general": {
            "name": "Brickwall",
            "isobjectvalid": true
        },
        "allplan": {
            "allplan_guid": "08b8195a-a2ad-11e2-9993-002215ea7d6b",
            "allplan_id": 2065507287,
            "allplan_text": "<PP>Wall",
            "dateofexport": "2013-05-01T09:32:13"
        }
    }
}

Get the object tree with full property list without geometry (object topology tree)

GET

Resource: objects/<object_id>/topology

URL: https://api.bimplus.net/v2/<team_slug>/objects/<object_id>/topology

Example: https://api.bimplus.net/v2/bimplus/objects/7cf910cb-e357-43f6-aa3a-b45c26380f75/topology

Get the object tree with full property list without geometry.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Status: 200 OK

{
    "parent": null,
    "name": "Brickwall",
    "type": "Project",
    "children": [],
    "id": "7cf910cb-e357-43f6-aa3a-b45c26380f75"
}

Get the optimized objects tree with selected property list whose geometry type is "ThreeJS"

GET

Resource: objects/<object_id>/geometries/threejs

URL: https://api.bimplus.net/v2/<team_slug>/objects/<object_id>/geometries/threejs

Example: https://api.bimplus.net/v2/bimplus/objects/7cf910cb-e357-43f6-aa3a-b45c26380f75/geometries/threejs

Get the optimized objects tree with selected property list whose geometry type is "ThreeJS".

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Status: 200 OK

{
    "elementsCount": 1,
    "viewbox": {
        "x": -5081.562,
        "y": 5005.8785,
        "z": 1231.1029999999996,
        "width": 5950,
        "height": 5540.835,
        "depth": 7065.71
    },
    "colors": [
        -9868951
    ],
    "objects": [
        {
            "id": "f5cc3c6c-1fdf-499d-a38d-0582adadc216",
            "type": "RoofLayer",
            "attributes": {
                "geometry": {
                    "threejs": {
                        "faces": [
                            0,
                            2,
                            1,
                            3,
                            0,
                            5,
                            3,
                            9,
                            1,
                            1,
                            14,
                            1,
                            5,
                            6,
                            15,
                            12,
                            1,
                            7,
                            4,
                            13,
                            14
                        ],
                        "vertices": [
                            -2106.562,
                            7588.114,
                            -2301.752,
                            -8056.562,
                            7588.114,
                            -2301.752,
                            -8056.562,
                            -880.999,
                            -4742.212,
                            6700,
                            -880.999,
                            -4742.212,
                            7412.539,
                            -1821.578,
                            -5522.212,
                            7412.539,
                            -1821.578
                        ],
                        "metadata": {
                            "formatVersion": 3,
                            "colorid": 0
                        }
                    }
                },
                "quantity": {
                    "length": 7065.71,
                    "height": 150,
                    "volume": 7911354818.818842,
                    "area": 52742365.4587924
                },
                "general": {
                    "name": "<PP>RoofLayer"
                }
            }
        }
    ]
}

Get the object tree with full property list whose geometry type is "compressed geometry mesh (meshblob)"

GET

Resource: objects/<object_id>/geometries/meshblob

URL: https://api.bimplus.net/v2/<team_slug>/objects/<object_id>/geometries/meshblob

Example: https://api.bimplus.net/v2/bimplus/objects/7cf910cb-e357-43f6-aa3a-b45c26380f75/geometries/meshblob

Get the object tree with full property list whose geometry type is "compressed geometry mesh (meshblob)".

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Status: 200 OK

{
    "elementsCount": 1,
    "objects": [
        {
            "id": "7cf910cb-e357-43f6-aa3a-b45c26380f75",
            "parent": "00000000-0000-0000-0000-000000000000",
            "type": "Wall",
            "attributes": {
                "geometry": {
                    "compress": true,
                    "picture": "H4sIAAAAAAAEANVXW3PbRBTWylIsuUmctml6T900t7aua+eetiHOndAQDLS8pBnhyzYVUeQiyR0cGJ545y9QGB54YYY3HvkXPPetQLlDuV/2E7uqiEfUMzRDkWc/zfl0tHvO2XPOWhKRJOkPduGOq1VmcLVQmPE8xywVzLJXc+iV+k06nE69QB3XrNpTQ9lcLpPNjExmxzIjufHRbDo1V7OgOGXTmucUrXSqUCtZZvkyrV+pblJ7yq5Zloo10qt0i3pu+QbdzKxe9UxrxSw5RaeemZstunTBYk9tr1C16rRCnTh7Qb1ZNW1PoZUNqlwvlqm2ZTxXrJg1t33LmKV2xbQ3nKplUcVjRsrL87FYTFGU2G3yfN316FZmDg/LHrPbzSxRmzpmObNiut6LubW1SFsCO9jSzJfdiMb6+luPwsQFFpfH28JFtmm7ZmFP5OrVmu3NOE6xjoRuUq03Sk0kJMyG4h4el6WaWYGsxwAKQGWQSKg/s5pqajoURfxW0apRw5A0TBbrkCTlJ/Z+eJU97IFsFGWjJBtl2ajIBpWN67KxIRs3ZMOUjZdkY1N6cGnxuMwvacelwNj/QX3AzBbDZEa6quGa21Qzbv01Jwv0QFO2ra3De03TNXbr4EPBPj3+xfeP7vc3Y1rgvc5uh/hQ1Efl/a4W9r/zHqYF3idQkXzEkQgSEZnQ11QW+RWOAtRbAW2AdkASgIn0vYB9gP2ATsABQBfgIADB1w8DjsAQXRiSgiGRrSK8n74dRwHHAMcB3YATAMyjnwT0AE4BegF9gH7AAGAQcBpwBnAWkAacA2QA5wFZQA4wxKBNiyf+FrqHWow98C0eBowARgFjgHHABGAScAFwEXAJa7WoiHZzm4NEIa+QOtlGxrS0YMn7g9felEsf5F+eSnz8zkfX8q92vr90Z/uNaYL9w9T3nv2wW5Xea1Ro26EgHgQK7VxBLNGgkAzP0PV2o0LHDoUGG/ZyBUE0KOzbodCwxP4dRooZ/CVfezdPOiO8CBQORCwRKHRFGBkoHIxw05eP3c6TQxF7ESgcjtiLQOFIRKiFgopaabqy1BLdMO0Y+0uJriHzXPfvKLejXPDz7TgnIOA0Id2cUPhr5AQn0G1bQKQ4AQH/a8lJTkBAVyI9nND4a+QUJ9AqUHyklxMJ7jjp4wQE5Dbp50Qrf40MhAzz5xgMTepbejpkGNKfnOEEBKQ7OcuJdhGPdGgV35dzITt8XzKhAKEiyHlOQEAFkCwnOoS3udCyvsZQ6BUsrQ43s51oO/BLxReDG3u9iYOOqyzb3vBQOrXllquOZZYeHGIj7ARjv4cfXaXx8eJoeXQsNzk8QrMTk+v+EaRPwRs0QL8TPgFpVEjTkMaElIc0LqQZSBNCmoU0KaQ5SBeENA/popAWIF0S0iJ2Hyb8x6GIPtHjKDhNX+Jp6tcQogSj9SfD7LRgl8NsXrBPhdkZwV7mSekn5qxgV8K6c4J9Oqw7L9jVsO6CYJ8Js4uCLYTYpHBJE61ENIykcEsTDUK0gaRwTRNlL4o7KdzTfmUfByiTH9gdlZEMXMRnhygxnCP4tP+Gje/YwLGRFG5r+MD4go3v2cB5kQxc/40xOCBwBqDN/8jkz9m4z8a3mF+EQ0OP/4wxaOVf4YkIifYJk75m4xc2PsUTERbtLpPusfE7G1/iI+dPBQ0gCIMQAAA=",
                    "type": 3,
                    "matrix": "AAAAAAAA8D8AAAAAAAAAgAAAAAAAAACAINejcP1YsEAAAAAAAAAAgAAAAAAAAPA/AAAAAAAAAIAK16Nw/fy2QAAAAAAAAACAAAAAAAAAAIAAAAAAAADwPwAArkfheoS/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8="
                }
            }
        }
    ]
}

Get the object tree with selected property list whose geometry type is "ThreeJS" filtered by layer

GET

Resource: objects/<object_id>/disciplines/<discipline_id>/geometries/threejs

URL: https://api.bimplus.net/v2/<team_slug>/objects/<object_id>/disciplines/<discipline_id>/geometries/threejs

Example: http://api.bimplus.net/v2/bimplus/objects/bded6990-b08b-4a27-a8bc-55c87ef2a8f8/disciplines/ac21b9a1-8853-4658-9fbf-0cf62340bd18/geometries/threejs

Get the object tree with selected property list whose geometry type is "ThreeJS" filtered by layer.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Status: 200 OK

{
    "elementsCount": 4,
    "faceCount": 154,
    "viewbox": {
        "x": 4067.5,
        "y": -480,
        "z": -4652.5,
        "width": 9775,
        "height": 600,
        "depth": 9695
    },
    "colors": [
        -4272966
    ],
    "objects": [
        {
            "id": "684d5deb-5ab0-419f-83dd-508755bf8b1b",
            "parent": "aa89eca9-795a-4dc9-b430-50973d0a12ce",
            "type": "WallLayer",
            "attributes": {
                "geometry": {
                    "threejs": {
                        "faces": [
                            1,
                            2,
                            1,
                            0,
                            3,
                            1,
                            5,
                            6,
                            7,
                            4,
                            1,
                            4,
                            7,
                            3,
                            0,
                            1,
                            5,
                            4,
                            0,
                            1,
                            1,
                            6,
                            5,
                            1,
                            2,
                            1,
                            7,
                            6,
                            2,
                            3
                        ],
                        "vertices": [
                            8955,
                            -780,
                            -9580,
                            -820,
                            -780,
                            -9580,
                            -820,
                            -780,
                            -9500,
                            8955,
                            -780,
                            -9500,
                            8955,
                            -180,
                            -9580,
                            -820,
                            -180,
                            -9580,
                            -820,
                            -180,
                            -9500,
                            8955,
                            -180,
                            -9500
                        ],
                        "metadata": {
                            "formatVersion": 3,
                            "colorid": 0
                        }
                    }
                },
                "quantity": {
                    "length": 9775,
                    "width": 80,
                    "height": 600,
                    "volume": 469200000.0000012,
                    "area": 5865000.000000014
                },
                "general": {
                    "name": "<PP>Wall layer"
                }
            }
        },
        {
            "id": "066c8b0a-aca0-456f-a5fc-747b8ae312e2",
            "parent": "041c2cec-09fb-49ae-9634-2998b305f2b5",
            "type": "WallLayer",
            "attributes": {
                "geometry": {
                    "threejs": {
                        "faces": [
                            1,
                            2,
                            1,
                            0,
                            3,
                            1,
                            5,
                            6,
                            7,
                            4,
                            1,
                            4,
                            7,
                            3,
                            0,
                            1,
                            5,
                            4,
                            0,
                            1,
                            1,
                            6,
                            5,
                            1,
                            2,
                            1,
                            7,
                            6,
                            2,
                            3
                        ],
                        "vertices": [
                            -820,
                            -780,
                            -9500,
                            -820,
                            -780,
                            115,
                            -740,
                            -780,
                            115,
                            -740,
                            -780,
                            -9500,
                            -820,
                            -180,
                            -9500,
                            -820,
                            -180,
                            115,
                            -740,
                            -180,
                            115,
                            -740,
                            -180,
                            -9500
                        ],
                        "metadata": {
                            "formatVersion": 3,
                            "colorid": 0
                        }
                    }
                },
                "quantity": {
                    "length": 9615,
                    "width": 80,
                    "height": 600,
                    "volume": 461520000.0000002,
                    "area": 5769000.000000003
                },
                "general": {
                    "name": "<PP>Wall layer"
                }
            }
        },
        {
            "id": "7f9314a1-1a6a-43ef-bf28-83fda655cb6b",
            "parent": "b62c83db-69ea-485b-9315-26826110e578",
            "type": "WallLayer",
            "attributes": {
                "geometry": {
                    "threejs": {
                        "faces": [
                            1,
                            2,
                            1,
                            0,
                            3,
                            1,
                            5,
                            6,
                            7,
                            4,
                            1,
                            4,
                            7,
                            3,
                            0,
                            1,
                            5,
                            4,
                            0,
                            1,
                            1,
                            6,
                            5,
                            1,
                            2,
                            1,
                            7,
                            6,
                            2,
                            3
                        ],
                        "vertices": [
                            -820,
                            -780,
                            195,
                            8875,
                            -780,
                            195,
                            8875,
                            -780,
                            115,
                            -820,
                            -780,
                            115,
                            -820,
                            -180,
                            195,
                            8875,
                            -180,
                            195,
                            8875,
                            -180,
                            115,
                            -820,
                            -180,
                            115
                        ],
                        "metadata": {
                            "formatVersion": 3,
                            "colorid": 0
                        }
                    }
                },
                "quantity": {
                    "length": 9695,
                    "width": 80,
                    "height": 600,
                    "volume": 465359999.99999976,
                    "area": 5816999.999999998
                },
                "general": {
                    "name": "<PP>Wall layer"
                }
            }
        },
        {
            "id": "4859603d-8153-4fcb-a2a4-fec3f5015dfc",
            "parent": "d1f15b9d-216a-478b-88f7-2767b5222bfe",
            "type": "WallLayer",
            "attributes": {
                "geometry": {
                    "threejs": {
                        "faces": [
                            1,
                            2,
                            1,
                            0,
                            3,
                            1,
                            5,
                            6,
                            7,
                            4,
                            1,
                            4,
                            7,
                            3,
                            0,
                            1,
                            5,
                            4,
                            0,
                            1,
                            1,
                            6,
                            5,
                            1,
                            2,
                            1,
                            7,
                            6,
                            2,
                            3
                        ],
                        "vertices": [
                            8955,
                            -780,
                            195,
                            8955,
                            -780,
                            -9500,
                            8875,
                            -780,
                            -9500,
                            8875,
                            -780,
                            195,
                            8955,
                            -180,
                            195,
                            8955,
                            -180,
                            -9500,
                            8875,
                            -180,
                            -9500,
                            8875,
                            -180,
                            195
                        ],
                        "metadata": {
                            "formatVersion": 3,
                            "colorid": 0
                        }
                    }
                },
                "quantity": {
                    "length": 9695,
                    "width": 80,
                    "height": 600,
                    "volume": 465360000.00000006,
                    "area": 5817000
                },
                "general": {
                    "name": "<PP>Wall layer"
                }
            }
        }
    ]
}

Get the object tree whose geometry type is "compressed geometry mesh (meshblob)" filtered by layer

GET

Resource: objects/<object_id>/disciplines/<discipline_id>/geometries/meshblob

URL: https://api.bimplus.net/v2/<team_slug>/objects/<object_id>/disciplines/<discipline_id>/geometries/meshblob

Example: http://api.bimplus.net/v2/bimplus/objects/bded6990-b08b-4a27-a8bc-55c87ef2a8f8/disciplines/ac21b9a1-8853-4658-9fbf-0cf62340bd18/geometries/meshblob

Get the object tree whose geometry type is "compressed geometry mesh (meshblob)" filtered by layer.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Status: 200 OK

{
    "elementsCount": 4,
    "objects": [
        {
            "id": "684d5deb-5ab0-419f-83dd-508755bf8b1b",
            "parent": "aa89eca9-795a-4dc9-b430-50973d0a12ce",
            "type": "WallLayer",
            "attributes": {
                "geometry": {
                    "compress": true,
                    "picture": "H4sIAAAAAAAEANVX624TRxTe2Yu9TkocIIQ7mDSXtpgljh0gldIGXBqhRsiCwJ/Imq7XQ9hmvaZ7QXUqFbXqg7Tq/z5DpT5Ef/cdeuXSdr7tjNkaOazURIGN5tucM2fnfOfsOTNrhSiK8je/cMf1hsrhTqNxNYoCt9VwnSgO2HrvAauWS3dZELpdf3lhvlKx5q3alUuLVqVaW+JT9diD4bLP4iiwvXKpEbc81/mI9da7W8xf9mPPM+CjfJN1WBQ699mWdfNO5Hprbiuwg55Vv2aH7LrHZ/2o0fV6rM2CPH/AeNB1/Uhn7U2m37MdZnboLbvtxuFYh15jftv1N4Ou5zE94iTVGx9omqbruvYtud0LI9ax6ph0Is47tFaZzwLXsdbcMPq4srExlEufB3fNY9mLbDSb3+wGxes8L682ww/5S9szhlNDvXdjP7oaBHYPBZ3RbHqYmSxI0IbhqMjLauy2IRc0gA4wADkOI8afvK8yLYnGyD+0vZhRqphYUBtXFP0P/nza0yifUKmt0pZKHZW2VcpUek+lmyq9r1JXpZ+odEt5fpn5vCouZeDSQfg16BHQzFGXkwwNGrrbzKQP/12TJ3suE7eNJqI3zUIBNzF0vKtXvwF3DH82C7V+9CPY3MXQjd2Kfk+b+/9FD2r96NE6OTGMXPYdodChiYIF/Ny5iw4NNe2LDIkTJjf8qLpQLnVCpxt4but5Umo8I/zv5aloXb5sLzqLlypL1Rqbv7LUbD7K7v42Px09tsv+k7ygjAoHsG+hrRQi+2omU08mS4wBioBxwEHAIcBhwATgCByMSAcw04duqOmqT9afBBwFHAMcB5wAnAScApwGnAGcBZQA5zgc0POj/wnrpV5RbYnXKcCbgGnADGAWMId1VR2J2+cCGt5XeTSLWXgLIcuBl7zfJbcj41HO+O0UYwOFla0OsS75jPTINhzkcniDn098v/rl0R9XPl0e+ek7ZX0F8s/bX79PUKpjwgCKFwzGBwwG7+RgygAuXjA4NGAgXWB64oevVsjhIRz6BhNDOPQNjgzhIA2MyZ0+hAabzGixTdfX+Hc4KkcVbwBtQ9B5k0LABDkmFMn3DRTHhUKTj50QCkO0HTkpFBDwY4CcEoq82MvJaaHIicfImZTbRHE25TZ5pJRymyx6Tih04cmYypICdHziBD9Nwv0+FJK95x1Eg70n2YTOQ5qWUhnSjJQuQJqVkgVpTkoXORTlFmDix+FffDzj4ykfRdlqfIN8r64oa3y8y8ejOoH75FyYT3UjOS+1lbS2LLULae0Fqa2mtZbU1tLai1K7mNIWpWtTlp0srqJ0bxqiEPLidRclhSRWLPmE339HrJKGiQzgoMMn+W+YkVRM5AUnFD72f8WMpGMiWzhFHvP7L/j/H73mm6ltDwAA",
                    "type": 3,
                    "matrix": "AAAAAAAA8D8AAAAAAAAAgAAAAAAAAACAAEfhehSgicAAAAAAAAAAgAAAAAAAAPA/AAAAAAAAAICF61G4/o3CQAAAAAAAAACAAAAAAAAAAIAAAAAAAADwP65H4XoUYIjAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8="
                }
            }
        },
        {
            "id": "066c8b0a-aca0-456f-a5fc-747b8ae312e2",
            "parent": "041c2cec-09fb-49ae-9634-2998b305f2b5",
            "type": "WallLayer",
            "attributes": {
                "geometry": {
                    "compress": true,
                    "picture": "H4sIAAAAAAAEANVXW28TRxTe2Yu9TiAOEFLumDSXtpgljh0gSGkDhkaoEbJK4CWypuv1ELZZr+leUJ1KoFb9IUW88xuqvvQn9Ln/ofcbnW87Y5YUh5WaKHSj+SbnzNk535w5Z2atEEVRnvEHPZ59KofbjcaVKArcVsN1ojhgq737rFou3WFB6Hb9xbnZSsWatWqXLsxblWptgQ/VYw+Giz6Lo8D2yqVG3PJc5wPWW+1uMH/Rjz3PgI/yTdZhUejcYxvWzduR6624rcAOelb9qh2y6x4f9aNG1+uxNgvy/AXjftf1I52115l+13aY2aEf2m03Dkc69Crz266/HnQ9j+kRJ6neuKZpmq7r2mNyqxdGrGPVMehEnHdoLTOfBa5jrbhh9FFlbW0glz4P7pqvZTei0Wx+tRMUr/O4vN4M3+ebtmsMJwZ678Z+dCUI7B4SOqPZ5CAzmZCgDcNhEZfl2G1DLmgAHWAAchyGjF95XWWaEoWRf2B7MaNUMTGhNqoo+i/8/bSnYT6gUlulLZU6Km2rlKn0rkrXVXpPpa5KP1bphvL8MfN5VTzKlkcH4f9BjYBmjrqcZGjQ0N1kJn3wz5w82DOZuK01sXrTLBTQiaZjr17/Atx2+dNZqPVXP4TDXTTd2KnV72px/7fVg1p/9SidnGhGLvuJUOjQRMECfu/cQYWGmvYwQ+CEyQ0/qs6VS53Q6Qae23oelBqPCP97dShaFy/a8878hcpCtcZmLy00m4+yu7/Fb0eP7bD/JC5Io8J+nFsoK4XIuprKVJPJFCOAImAUcABwEHAIMAY4DAdD0gHM9IEHajrrk/nHAW8AjgCOAo4BjgNOAE4CTgFOA0qAMxz26/nhF5b1Sq/ItsTrBOBNwCRgCjANmMG8qo7A7XECDa6rPIrFLLyFJcuGTd7rlNuW8TBn/HaKsYHEypaHmJd8SnpkEw5yOezgZ2NPl7/f/PI99J9/+82SlAlSdWSLQbono8Lgk8Wh754oq0v/MjjwEoMXXBx8iQsYQBr7+oslcmgAh77B2AAOfYPDAzhIA2N8uw+hrUVmtNi662v8OxyZo4odQNkQVN64EDBAjghF8n0DxVGh0ORrx4TCEGVHjgsFBPwYICeEIi/OcnJSKHLiNXIq5TZRnE65TV4ppdwmk54RCl14MiayhAAVnzjBT5Nwry+F5Ox5B6vB2ZMcQmchTUqpDGlKSucgTUvJgjQjpfMcivIIMPHj8C/e/uTtD96KstT4AfluXVFWeLvM26M6gfvkXphNVSM5K7WVtLYstXNp7Tmpraa1ltTW0trzUjuf0hala1OmnUyuonRvGiIR8mK7i5JCslZM+Tvvf8ZaJQ0TEcBFh0/ynzAiqZiIC24ofOz/iBFJx0S0cIv8xvsf8P/f/WbD220PAAA=",
                    "type": 3,
                    "matrix": "AAAAAAAA8D8AAAAAAAAAgAAAAAAAAACA/kbhehSgicAAAAAAAAAAgAAAAAAAAPA/AAAAAAAAAIAAPwrXo8BcwAAAAAAAAACAAAAAAAAAAIAAAAAAAADwP65H4XoUYIjAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8="
                }
            }
        },
        {
            "id": "7f9314a1-1a6a-43ef-bf28-83fda655cb6b",
            "parent": "b62c83db-69ea-485b-9315-26826110e578",
            "type": "WallLayer",
            "attributes": {
                "geometry": {
                    "compress": true,
                    "picture": "H4sIAAAAAAAEANVXW28TRxTe2Yu9TkocIIQ7mJBLC2aJYwdIpbSASyNEhKwSeIms6Xo9hCXrNewF1alU1Ko/pFXf+xuq/ok+9xf0pff7fMuMWYwcVmqi0I3mm8yZs3O+c+acmbVCFEX5hz/o8byhcrjbaFyLosBtNVwnigO21nvEquXSPRaEbtdfXpivVKx5q3bl0qJVqdaW+FQ99qC47LM4CmyvXGrELc91brHeWneT+ct+7HkGbJRvsw6LQucB27Ru341cb9VtBXbQs+rX7ZDd8PisHzW6Xo+1WZDnLxiPuq4f6ay9wfT7tsPMDv3AbrtxONah15nfdv2NoOt5TI84SfXme5qm6bqufUnu9MKIdaw6Jp2I8w6tFeazwHWsVTeMPqysrw/l0ufBTXNfdiMazeYXO0HxBo/L683wfb5pu8Zwaqj1buxH14LA7iGhM6pND1OTCQnaUBwVcVmJ3TbGBQ2gAwxAjsOI8Ruvq0xLojDyT2wvZpQqJhbUxhVF/5W/n7Y0yidUaqu0pVJHpW2VMpXeV+mGSh+o1FXpQ5VuKs8fM59XxaMMPDoI/w9qBDRz1OUkQ4OG7hYz6ZNna/Jgz2Xitt6E96ZZKKATTcdevf4FuK37s1mo9b0fweEumm7slPe7Wtz/zXtQ63uP0smJZuSynwiFDk0ELOD3zj1UaKhpn2QInFC56UfVhXKpEzrdwHNbz4NS4xHhf68ORevyZXvRWbxUWarW2PyVpWbzaXbzd/jt6LEdtp/EBWlU2IdzC2WlEFlXM5lqMlliDFAEjAP2Aw4ADgImAIdgYEQagJo+9EBNZ32y/iTgMOAI4CjgGOA44ATgJOAU4DSgBDjDYZ+eH33BrVdaRbYlVqcAZwHTgBnALGAO66o6ArfHCTS8rvIoFrPwJlyWDZu81ym3LeNRzvitFGMDiZUtD7Eu+Yj0yBYM5HLYwY8nvl75fuvzdwd7glQdEwqf/vDt1ZcUxgcUHi+PfPeVstZXJPtTChC8pHBgQEH2wIlvPrtKDg7h0FeYGMKhr3BoCAepYExu9yE0WGRGi224vsa/w5E5qtgBlA1B5U2KASbIESFIvm8gOCoEmnztmBAYouzIcSHAAD8GyAkhyIuznJwUgpx4jZxKmU0Ep1Nmk1dKKbPJomeEQBeWjKksIUDFJ0bw0yTc60shOXvOwRucPckhdB6jaTkqYzQjRxcwmpUjC6M5ObrIoSiPABM/Dv/m7S/e/uStKEuNH5Dv1BVllbe3eXtaJzCf3AvzqWok56W0kpaWpXQhLb0gpdW01JLSWlp6UUoXU9KiNG3KtJPJVZTmTUMkQl5sd1FSSHzFkn/w/hf4KmmYiAAuOnyS/4wZScVEXHBD4WP/J8xIOiaihVvkd97/iP//BRHHAGFtDwAA",
                    "type": 3,
                    "matrix": "AAAAAAAA8D8AAAAAAAAAgAAAAAAAAACAAEfhehSgicAAAAAAAAAAgAAAAAAAAPA/AAAAAAAAAIB5H4XrUWBowAAAAAAAAACAAAAAAAAAAIAAAAAAAADwP65H4XoUYIjAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8="
                }
            }
        },
        {
            "id": "4859603d-8153-4fcb-a2a4-fec3f5015dfc",
            "parent": "d1f15b9d-216a-478b-88f7-2767b5222bfe",
            "type": "WallLayer",
            "attributes": {
                "geometry": {
                    "compress": true,
                    "picture": "H4sIAAAAAAAEANVXW28TRxTeq71OShwghDuYNJcWzBLHDpBKaQGXRqgRskrgJbKm6/UQhqzXsBdUp1JRq/6QVn3vb6j6J/rcX9CXtrTQFubbzphNhMNKTRS60XybOXNmznfOnDOzVlRFUZ7zB288b2kcbjcaV6MoYK0Gc6M4oCu9B7RaLt2hQci6/uLcbKViz9q1yxfn7Uq1tsCH6rEHxUWfxlHgeOVSI255zP2Y9la669Rf9GPPM2GjfJN2aBS69+i6ffN2xLxl1gqcoGfXrzkhve7xUT9qdL0ebdMgzyeYD7rMjwzaXqPGXcelVod84rRZHI50yDXqt5m/FnQ9jxoRJ6nd+FDXdcMw9G/VW70woh27jkE34rxDe4n6NGCuvczC6NPK6upALn0e3DT3ZTei0Wx+sxMUr/O4vNkMP+KbtmsMJwZa78Z+dDUInB4SOqPa5CA1mZCgDcVhEZelmLXRL+gAA2ACchyGzD95XWVaEoWRf+R4MSVEsbCgPqooxh98ftrSMB/QiKORlkZcjbQ1QjVyVyNrGrmnEaaR+xpZV14+Vj6viUfZ8hgg/D+oEdDMEcZJhiYJ2Qa1yKN/1+TBnsnEbbUJ7y2rUMBLNAN79eYX4LbuT2eh1vd+CIe7aIa5U97vanH/N+9Bre89SicnmpnLfiIUOiQR0IDfO3dQoaGuf5EhcELlhh9V58qlTuh2A4+1XgalxiPC/14fitalS868O3+xslCt0dnLC83m4+zmb/Hb0aM7bD+JC9KosA/nFspKUWVdTWWqyWSJEUARMArYDzgAOAgYAxyCgSFpAGrGwAM1nfXJ+uOAw4AjgKOAY4DjgBOAk4BTgNOAEuAMh31GfniTW6+1imxLrE4A3gZMAqYA04AZrKsZCNweJ9DgusqjWKzCO3BZNmzyXqfctoyHOeN3U4xNJFa2PMS66mdqT92AgVwOO/hwcein75SVK5+Pfb/088bXH8i3ilQd2aLw5S8/9hXVUaGQnrlJYf8rFDaZOPAKExgAjv3w1RX14AAOfYWxARz6CocGcJAK5vh2H0Jbi8xs0TXm6/w7HJmjiR1A2aiovHHRwYB6RAiS7xsIjgqBLqcdEwJTlJ16XAjQwY8B9YQQ5MVZrp4UgpyYpp5KmU0Ep1NmkymllNlk0TNCYAhL5kSWEKDiEyP4aRLu9aWQnD1n4Q3OnuQQOofepOyV0ZuSvfPoTcuejd6M7F3gUJRHgIUfh//w9jdvf/FWlKXGD8j364qyzNt7vD2uqzCf3AuzqWpUz0lpJS0tS+lcWnpeSqtpqS2ltbT0gpTOp6RFadqSaSeTqyjNW6ZIhLzY7qKkkPiKJZ/x9xP4KmlYiAAuOnyS/44RScVCXHBD4WP/N4xIOhaihVvkKX//iv9fAChNaqptDwAA",
                    "type": 3,
                    "matrix": "AAAAAAAA8D8AAAAAAAAAgAAAAAAAAACAkOtRuH5VwUAAAAAAAAAAgAAAAAAAAPA/AAAAAAAAAIDAHoXrUWBowAAAAAAAAACAAAAAAAAAAIAAAAAAAADwP65H4XoUYIjAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8="
                }
            }
        }
    ]
}

Update the object

PUT

Resource: objects/<object_id>

URL: https://api.bimplus.net/v2/<team_slug>/objects/<object_id>

Example: https://api.bimplus.net/v2/bimplus/objects/7cf910cb-e357-43f6-aa3a-b45c26380f75

JSON Structure:

Name	Mandatory / Optional	Type	Description
parent	optional	string (guid)	The id of the parent to which the object can be associated
type	mandatory	string	Element type of the object
attributes	optional	string	Attributes of the object
children	optional	object	Children of the object

Update or replace a specified existing object with a new one.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

{
    "parent" : "02dc3da7-600a-494d-9b2b-e72b74143062",
    "type": "Wall",
    "attributes": {
        "element": {
            "isparent": true,
            "nr": 0,
            "matrix": "AAAAAAAA8D8AAAAAAAAAgAAAAAAAAACAINejcP1YsEAAAAAAAAAAgAAAAAAAAPA/AAAAAAAAAIAK16Nw/fy2QAAAAAAAAACAAAAAAAAAAIAAAAAAAADwPwAArkfheoS/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8=",
            "elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
             "divisionid": "ac21b9a1-8853-4658-9fbf-0cf62340bd18"
        },
        "general": {
            "name": "Brickwall",
            "isobjectvalid": true
        },
        "quantity": {
            "width": 115
        },
        "allplan": {
            "allplan_guid": "08b8195a-a2ad-11e2-9993-002215ea7d6b",
            "allplan_id": 2065507287,
            "allplan_text": "<PP>Wall",
            "dateofexport": "2013-05-01T09:32:13"
        },
        "geometry": {
            "mesh": "{\"C\":4278255360,\"V\":[4450.01,115.01,0.01,3200.01,115.01,0.01,3200.01,0.01,0.01,4450.01,0.01,0.01,2315.01,0.01,0.01,2315.01,115.01,0.01,0.01,115.01,0.01,0.01,0.01,0.01,4450.01,115.01,2750.01,4450.01,0.01,2750.01,0.01,0.01,2750.01,0.01,115.01,2750.01,2315.01,115.01,2190.01,3200.01,115.01,2190.01,3200.01,0.01,2190.01,2315.01,0.01,2190.01],\"F\":[4,0,1,2,3,4,4,5,6,7,4,8,9,10,11,4,0,3,9,8,8,6,5,12,13,1,0,8,11,4,7,6,11,10,8,3,2,14,15,4,7,10,9,4,12,15,14,13,4,15,12,5,4,4,13,14,2,1]}"
        }
    }
}

Status: 200 OK

Create a new attachment in the object

POST

Resource: objects/<object_id>attachments

URL: https://api.bimplus.net/v2/<team_slug>/objects/<object_id>attachments

Example: https://api.bimplus.net/v2/bimplus/objects/7cf910cb-e357-43f6-aa3a-b45c26380f75/attachments

JSON Structure: Please note that all the information required for this call will be taken from the document that you attach and hence the request of this call has no body.

Name	Mandatory / Optional	Type	Description
objectIds	will be ignored	string	The id of the project objects to which the file has to be attached
fileName	will be ignored	string	Name of the file to be attached to the project
type	will be ignored	string	Mime type
size	will be ignored	integer	Size of the file to be attached to the project

Create a new attachment in a object.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: multipart/form-data

Status: 201 Created

[
    {
        "objectIds": [
            "7cf910cb-e357-43f6-aa3a-b45c26380f75"
        ],
        "fileName": "Door_Model.jpg",
        "type": "image/jpeg",
        "size": 211258,
        "id": "d0b3fc78-8f60-4e3f-ae72-65beb3dcb7d2"
    }
]

Get the attachment list from the object

GET

Resource: objects/<object_id>attachments

URL: https://api.bimplus.net/v2/<team_slug>/objects/<object_id>attachments

Example: https://api.bimplus.net/v2/bimplus/objects/7cf910cb-e357-43f6-aa3a-b45c26380f75/attachments

Get all the attachments belonging to a specified object.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Status: 200 OK

[
    {
        "objectIds": [
            "7cf910cb-e357-43f6-aa3a-b45c26380f75"
        ],
        "fileName": "Door_Model.jpg",
        "type": "image/jpeg",
        "size": 211258,
        "id": "d0b3fc78-8f60-4e3f-ae72-65beb3dcb7d2"
    }
]

Delete all the attachments from the object

DELETE

Resource: objects/<object_id>/attachments

URL: https://api.bimplus.net/v2/<team_slug>/objects/<object_id>/attachments

Example: https://api.bimplus.net/v2/bimplus/objects/7cf910cb-e357-43f6-aa3a-b45c26380f75/attachments

Delete all the attachments from a specified object.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Status: 200 OK

Delete the object

DELETE

Resource: objects/<object_id>

URL: https://api.bimplus.net/v2/<team_slug>/objects/<object_id>

Example: https://api.bimplus.net/v2/bimplus/objects/7cf910cb-e357-43f6-aa3a-b45c26380f75

Deletes a specified object.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Status: 200 OK

[3]
0:  {
id: "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
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"
}

ElementType Service

Element type describes the type of predefined building elements required to build a building (eg: wall, window, door etc) Each element type have an unique id. Please see the detailed structure of the ElementType in the Object Model

The available element types can be found under 2.1.4.1 Bimplus Element Types

Get the element types

GET

Resource: element-types

URL: https://api.bimplus.net/v2/<team_slug>/element-types

Example: https://api.bimplus.net/v2/bimplus/element-types

Gets the list of existing element types.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Status: 200 OK

[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"
}
...

Get the element type properties

GET

Resource: element-types/<element_type_id>

URL: https://api.bimplus.net/v2/<team_slug>/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.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Status: 200 OK

{
type: "Chimney"
category: "/1/10/8/"
name: "Chimney"
ifcType: "ID_IFCBuildingElementProxy"
id: "e504f24c-e643-452b-b901-6a18883dc7e9"
}

Get the list of existing layers

GET

Resource: element-types/disciplines

URL: https://api.bimplus.net/v2/<team_slug>/element-types/disciplines

Example: https://api.bimplus.net/v2/bimplus/element-types/disciplines

Gets the list of existing layers.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Status: 200 OK

{
-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"
}
}
...

Division Service

Not used in the current edition!

A division is a part(department/client) of a team which works on the project.

Attachment Service

Attachments are mostly documents or any media files with additional information which can be assigned to any project, object or issue. Please see the detailed structure of the attachment in the Object Model

Please use the Bimplus Project Service for creating/deleting an attachment or for getting all the attachments of a project
Please use the Bimplus Object Service for creating/deleting an attachment or for getting all the attachments of an object
Please use the Bimplus Issue Service for creating/deleting an attachment or for getting all the attachments of an issue

Get Attachment information

GET

Resource: attachments/<attachment_id>

URL: https://api.bimplus.net/v2/<team_slug>/attachments/<attachment_id>

Example: https://api.bimplus.net/v2/bimplus/attachments/d0b3fc78-8f60-4e3f-ae72-65beb3dcb7d2

Get detailed information about a specified attachment.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Status: 200 OK

{
    "objectIds": [
        "7cf910cb-e357-43f6-aa3a-b45c26380f75"
    ],
    "fileName": "Door_Model.jpg",
    "type": "image/jpeg",
    "size": 211258,
    "id": "d0b3fc78-8f60-4e3f-ae72-65beb3dcb7d2"
}

Download the attachment

GET

Resource: attachments/<attachment_id>/download

URL: https://api.bimplus.net/v2/<team_slug>/attachments/<attachment_id>/download

Example: https://api.bimplus.net/v2/bimplus/attachments/d0b3fc78-8f60-4e3f-ae72-65beb3dcb7d2/download

Download the content of a specified attachment.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Status: 200 OK

Update the attachment

GET

Resource: attachments/<attachment_id>

URL: https://api.bimplus.net/v2/<team_slug>/attachments/<attachment_id>

Example:

JSON Structure:

Name	Mandatory / Optional	Type	Description
objectIds	optional	string	The id of the objects to which the file has to be attached
fileName	optional	string	Name of the file to be attached to the project
type	optional	string	Mime type
size	optional	integer	Size of the file to be attached to the project

Update or replace a specified existing attachment with a new one.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Status: 200 OK

Delete the Attachment

GET

Resource: attachments/<attachment_id>

URL: https://api.bimplus.net/v2/<team_slug>/attachments/<attachment_id>

Example: https://api.bimplus.net/v2/bimplus/attachments/d0b3fc78-8f60-4e3f-ae72-65beb3dcb7d2

Deletes a specified attachment.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Status: 200 OK

Issue Service

Issues are problems or remarks which can be assigned to any project. Comments or attachments can be added to the issue. Please see the detailed structure of the issue in the Object Model

Please use the Bimplus Project Service for creating/deleting an issue or for getting all the issues assigned to a project

Get details of the issue

GET

Resource: issues/<issue_id>

URL: https://api.bimplus.net/v2/<team_slug>/issues/<issue_id>

Example: https://api.bimplus.net/v2/bimplus/issues/8ead8bfe-ab23-4340-ac47-38181e83bff3

Get details of an issue present in a project.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Status: 200 OK

{
    "projectId": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
    "name": "Fire Exit Wrong",
    "description": "The fire exit is in the wrong place",
    "author": "Mr. Smart",
    "status": "open",
    "createdAt": "2013-06-02T10:05:00+00:00",
    "dueDate": "2013-06-05T10:05:00+00:00",
    "solution": null,
    "classification": "",
    "priority": "very high",
    "revision": null,
    "id": "8ead8bfe-ab23-4340-ac47-38181e83bff3"
}

Get all the issue types (Not implemented)

GET

Resource: issues/types

URL: https://api.bimplus.net/v2/<team_slug>/issues/types

Example: https://api.bimplus.net/v2/bimplus/issues/types

Get all the available issue types.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Status: 200 OK

Get details of the issue type (Not implemented)

GET

Resource: issues/types/<type_id>

URL: https://api.bimplus.net/v2/<team_slug>/issues/types/<type_id>

Get details of a specified issue type.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Status: 200 OK

Create a new pin for the issue

POST

Resource: issues/<issue_id>/pins

URL: https://api.bimplus.net/v2//issues//pins

Example: https://api.bimplus.net/v2//issues/8ead8bfe-ab23-4340-ac47-38181e83bff3/pins

JSON Structure:

Name	Mandatory / Optional	Type	Description
issueId	will be ignored	string (guid)	The id of the issue to which the pin is related
objectId	mandatory	string (guid)	The id of the object to which the pin is related
topologyNodeId	will be ignored	string (guid)	The id of the topology to which the pin is attached
position	optional	object	The position of the issue in the building (x,y,z co-ordinates)
normalVector	optional	object	The direction of the issue in the 3D space (x,y,z co-ordinates)
createdAt	will be ignored	date	The creation date

Create a new pin for an issue for relating the issue with its object.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

{
    "objectId": "7cf910cb-e357-43f6-aa3a-b45c26380f75",
    "position": {
        "x": "123.45",
        "y": "234.56",
        "z": "345.67"
    },
    "normalVector": {
        "x": "0",
        "y": "1",
        "z": "2"
    }
}

Status: 201 Created

{
    "issueId": "8ead8bfe-ab23-4340-ac47-38181e83bff3",
    "objectId": "7cf910cb-e357-43f6-aa3a-b45c26380f75",
    "topologyNodeId": "387fa6cc-b6f9-4470-8c42-c07982aba660",
    "position": {
        "x": "123.45",
        "y": "234.56",
        "z": "345.67"
    },
    "normalVector": {
        "x": "0",
        "y": "1",
        "z": "2"
    },
    "createdAt": "2013-06-07T10:07:00+00:00",
    "id": "8836308d-f09f-4bb7-b6d2-354a2db205a6"
}

Get all the pins of the issue

GET

Resource: issues/<issue_id>/pins

URL: https://api.bimplus.net/v2//issues//pins

Example: https://api.bimplus.net/v2/bimplus/issues/8ead8bfe-ab23-4340-ac47-38181e83bff3/pins

Get all the pins of a specified issue type.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Status: 200 OK

[
    {
        "issueId": "8ead8bfe-ab23-4340-ac47-38181e83bff3",
        "objectId": "00000000-0000-0000-0000-000000000000",
        "topologyNodeId": "387fa6cc-b6f9-4470-8c42-c07982aba660",
        "position": {
            "x": 123.45,
            "y": 234.56,
            "z": 345.67
        },
        "normalVector": {
            "x": 0,
            "y": 1,
            "z": 2
        },
        "createdAt": "2013-06-07T10:07:00",
        "id": "8836308d-f09f-4bb7-b6d2-354a2db205a6"
    }
]

Delete all the pins from the issue

DELETE

Resource: issues/<issue_id>/pins

URL: https://api.bimplus.net/v2/<team_slug>/issues/<issue_id>/pins

Example: https://api.bimplus.net/v2/bimplus/issues/8ead8bfe-ab23-4340-ac47-38181e83bff3/pins

Delete all the pins from a specified issue.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Status: 200 OK

Create a new comment for the issue

POST

Resource: issues/<issue_id>/comments

URL: https://api.bimplus.net/v2/<team_slug>/issues/<issue_id>/comments

Example: https://api.bimplus.net/v2//issues/cb96a9b1-48c9-4d97-8c9e-262476c1c6b2/comments

JSON Structure:

Name	Mandatory / Optional	Type	Description
text	mandatory	string	The comment text
createdAt	will be ignored	string (date)	Creation date of the comment
author	will be ignored	string	The author of the comment

Create a new comment for a specified issue.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

{
    "text": "The fire exit should be x:120, y: 120; z: 340"
}

Status: 201 Created

{
    "issueId": "cb96a9b1-48c9-4d97-8c9e-262476c1c6b2",
    "text": "The fire exit should be x:120, y: 120; z: 340",
    "createdAt": "2013-07-02T13:26:18.8932853+00:00",
    "author": "132a78a5-b523-4bf2-8382-7098fac3f803",
    "id": "d258c905-c8af-4463-b0d8-ac09dbcfc255"
}

Get all the comments of the issue

GET

Resource: issues/<issue_id>/comments

URL: https://api.bimplus.net/v2/<team_slug>/issues/<issue_id>/comments

Example: https://api.bimplus.net/v2//issues/cb96a9b1-48c9-4d97-8c9e-262476c1c6b2/comments

Get all the comments of a specified issue.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Status: 200 OK

[
    {
        "issueId": "cb96a9b1-48c9-4d97-8c9e-262476c1c6b2",
        "text": "The fire exit should be x:120, y: 120; z: 340",
        "createdAt": "2013-07-02T13:26:18+00:00",
        "author": "132a78a5-b523-4bf2-8382-7098fac3f803",
        "id": "d258c905-c8af-4463-b0d8-ac09dbcfc255"
    }
]

Delete the comment

DELETE

Resource: issues/<issue_id>/comments/<comment_id>

URL: https://api.bimplus.net/v2/<team_slug>/issues/<issue_id>/comments/<comment_id>

Example: https://api.bimplus.net/v2//issues/cb96a9b1-48c9-4d97-8c9e-262476c1c6b2/comments/d258c905-c8af-4463-b0d8-ac09dbcfc255

Deletes a specified comment.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Status: 200 OK

Create a new attachment for the issue

POST

Resource: issues/<issue_id>/attachments

URL: https://api.bimplus.net/v2//issues//attachments

Example:https://api.bimplus.net/v2/bimplus/issues/8ead8bfe-ab23-4340-ac47-38181e83bff3/attachments

JSON Structure: Please note that all the information required for this call will be taken from the document that you attach and hence the request of this call has no body.

Name	Mandatory / Optional	Type	Description
objectIds	will be ignored	string	The id of the project objects to which the file has to be attached
fileName	will be ignored	string	Name of the file to be attached to the project
type	will be ignored	string	Mime type
size	will be ignored	integer	Size of the file to be attached to the project

Creates a new attachment for a specified issue.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: multipart/form-data

Status: 201 Created

[
    {
        "objectIds": [
            "8ead8bfe-ab23-4340-ac47-38181e83bff3"
        ],
        "fileName": "FireExit_Wrong.jpg",
        "type": "image/jpeg",
        "size": 211258,
        "id": "db9e340a-08a6-4306-92b2-c51c0063c206"
    }
]

Get the attachment list from the issue

GET

Resource: issues/<issue_id>/attachments

URL: https://api.bimplus.net/v2/<team_slug>/issues/<issue_id>/attachments

Example: https://api.bimplus.net/v2/bimplus/issues/8ead8bfe-ab23-4340-ac47-38181e83bff3/attachments

Gets the attachment list from a specified issue.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Status: 200 OK

[
    {
        "objectIds": [
            "8ead8bfe-ab23-4340-ac47-38181e83bff3"
        ],
        "fileName": "FireExit_Wrong.jpg",
        "type": "image/jpeg",
        "size": 211258,
        "id": "db9e340a-08a6-4306-92b2-c51c0063c206"
    }
]

Delete all the attachments from the issue

DELETE

Resource: issues/<issue_id>/attachments

URL: https://api.bimplus.net/v2//issues//attachments

Example:https://api.bimplus.net/v2/bimplus/issues/8ead8bfe-ab23-4340-ac47-38181e83bff3/attachments

Delete all the attachments from a specified issue.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Status: 200 OK

Update the issue

PUT

Resource: issues/<issue_id>

URL: https://api.bimplus.net/v2/<team_slug>/issues/<issue_id>

Example: https://api.bimplus.net/v2/bimplus/issues/8ead8bfe-ab23-4340-ac47-38181e83bff3

JSON Structure:

Name	Mandatory / Optional	Type	Description
projectId	will be ignored	string (guid)	Id of the project
name	optional	string	Name of the issue
description	optional	string	Description of the issue
author	optional	string	Author of the issue
status	optional	string	Status of the issue
createdAt	will be ignored	string (date)	Creation date of the issue
dueDate	optional	string (date)	The date in which the issue is planned to be finished
solution	optional	string	The proposed solution for the issue
classification	optional	string	The classification to which the issues belongs
priority	optional	string	The priority of the issue

Update or replace a specified existing issue with a new one.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

{
    "name": "Fire Exit Wrong",
    "description": "The fire exit is in the wrong place(x:120, y: 120; z: 340)",
    "author": "Mr. Smart",
    "status": "open"
}

Status: 200 OK

Delete the issue

DELETE

Resource: issues/<issue_id>

URL: https://api.bimplus.net/v2/<team_slug>/issues/<issue_id>

Example: https://api.bimplus.net/v2/bimplus/issues/8ead8bfe-ab23-4340-ac47-38181e83bff3

Deletes a specified issue.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Status: 200 OK

Pin Service

Pins are relation between an issue and an object. It defines position of an issue in the 3D space. Please see the detailed structure of the pin in the Object Model

Please use the Bimplus Issue Service for creating/deleting a pin or for getting all the pins assigned to an issue

Get details of the pin

GET

Resource: pins/<pin_id>

URL: https://api.bimplus.net/v2//pins/

Example:https://api.bimplus.net/v2/bimplus/pins/8836308d-f09f-4bb7-b6d2-354a2db205a6

Get details of a specified pin.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Status: 200 OK

{
    "issueId": "8ead8bfe-ab23-4340-ac47-38181e83bff3",
    "objectId": "7cf910cb-e357-43f6-aa3a-b45c26380f75",
    "topologyNodeId": "387fa6cc-b6f9-4470-8c42-c07982aba660",
    "position": {
        "x": 123.45,
        "y": 234.56,
        "z": 345.67
    },
    "normalVector": {
        "x": 0,
        "y": 1,
        "z": 2
    },
    "createdAt": "2013-06-07T10:07:00",
    "id": "8836308d-f09f-4bb7-b6d2-354a2db205a6"
}

Update the pin

PUT

Resource: pins/<pin_id>

URL: https://api.bimplus.net/v2//pins/

Example: https://api.bimplus.net/v2/bimplus/pins/8836308d-f09f-4bb7-b6d2-354a2db205a6

JSON Structure:

Name	Mandatory / Optional	Type	Description
issueId	mandatory	string (guid)	The id of the issue to which the pin is related
objectId	mandatory	string (guid)	The id of the object to which the pin is related
newObjectId	optional	string (guid)	It should be specified when the pin is assigned to another object via update
topologyNodeId	optional	string (guid)	The id of the topology to which the pin is attached
position	optional	object	The position of the issue in the building (x,y,z co-ordinates)
normalVector	optional	object	The direction of the issue in the 3D space (x,y,z co-ordinates)
createdAt	will be ignored	date	The creation date

Update or replace a specified existing pin with a new one.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

{
    "issueId": "8ead8bfe-ab23-4340-ac47-38181e83bff3",
    "objectId": "7cf910cb-e357-43f6-aa3a-b45c26380f75",
    "position": {
        "x": 123.45,
        "y": 234.56,
        "z": 345.67
    },
    "normalVector": {
        "x": 0,
        "y": 1,
        "z": 2
    }
}

Status: 200 OK

Delete the pin

DELETE

Resource: pins/<pin_id>

URL: https://api.bimplus.net/v2//pins/

Example: https://api.bimplus.net/v2/bimplus/pins/8836308d-f09f-4bb7-b6d2-354a2db205a6

Deletes a specified pin.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Status: 200 OK

Import Service

This service is used for creating a new project by importing the existing projects in the form of IFC and SketchUp files into a team base.

Create a new project by importing SketchUp and IFC files

POST

Resource: import

URL: https://api.bimplus.net/v2/<team_slug>/import

Example: https://api.bimplus.net/v2/bimplus/import

Create a new project by importing SketchUp and IFC files into the team database.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Status: 201 Created

Create a new sub-project by importing SketchUp and IFC files (Not implemented)

POST

Resource: projects/<project_id>/import

URL: https://api.bimplus.net/v2/<team_slug>/projects/<project_id>/import

Example: https://api.bimplus.net/v2/bimplus/projects/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e/import

Create a new sub-project by importing SketchUp and IFC files into the project.

Authorization Service

Authorizes a user and returns a token for further API calls

POST

Resource: authorize

URL: https://api.bimplus.net/v2/authorize

JSON Structure:

Name	Mandatory / Optional	Type	Description
user_id	mandatory	string	The email address of the user
password	mandatory	string	The user's password
client_id	optional	string	The identifier of the used client
application_id	optional	string	The id of the application

Authorizes a user and returns a token for further API calls.

Please, use the client_id from the request and regenerate the token (using the same API call with client_id as the additional parameter) for having the possibility to login multiple times at the same time. For more information, see here

Content-Type: application/json

{
 "user_id" : "test@bimplus.net",
 "password" : "test"
}

Status: 200 OK

{
"access_token": "9c1874a62c974dcfa75e0132c423a088",
"expires_in": 2591999,
"client_id": "9fd0bb9d-570b-4719-bfae-93e2f879c19a",
"token_type": "BimPlus"
}

Get token information

GET

Resource: tokeninfo?access_token=<token>

URL: https://api.bimplus.net/v2/tokeninfo?access_token=<token>

Example:

Get information about a specified token(if the specified token exists and not expired).

Content-Type: application/json

Status: 200 OK

{
    "user_id": "b37b60d4-0f1b-4158-99c4-847254786517",
    "audience": "00000000-0000-0000-0000-000000000000",
    "expires_in": 2271650

}

where,

Name	Type	Description
user_id	The unique user id to be used for any further API calls.
expires_in	The remaining lifetime on the access token in seconds
audience	In our case the id of the client (Mobile app, Browser …)

Request a cross token

POST

Resource: cross-token

URL: https://api.bimplus.net/v2/cross-token

This service is basically used for requesting a disposable temporary token which will be used for authenticating against different clients. Based on the given authentication token the user is identified and a one time token is generated and returned.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Status: 200 OK

{
cross_token: "b392cee4d0044ef681fa911772668cf9"
expires_in: 299
token_type: "BimPlus"
}

where,

Name	Type	Description
cross_token	string	The temporary token which will be used for cross-authenticate
expires_in	string	The remaining lifetime on the access token in seconds
token_type	string	Type of the token which will be used as part of the header

Cross Authenticate by using cross token

POST

Resource: cross-authorize

URL: https://api.bimplus.net/v2/cross-authorize

JSON Structure:

Name	Mandatory / Optional	Type	Description
cross_token	mandatory	string	The temporary token which will be used for cross-authenticate
client_id	optional	string	The identifier of the used client
team_id	optional	string	The id of the team
project_id	optional	string	The id of the project
application_id	optional	string	The id of the application

Based on the one time cross token, the user will be identified and logged in to the given device/client. The one time cross token will be removed but the new token which will be generated as a result of this call be used in the header for the subsequent API calls.

The team_id and project_id information can be provided as part of the call, if the user wants to work on or display(viewer) a particular team or an project.

Content-Type: application/json

{
"cross_token": "b392cee4d0044ef681fa911772668cf9"
}

Status: 200 OK

{
"access_token": "43796fab76d54d2c9cb9120fd7d79c9e",
"expires_in": 2591999,
"client_id": "9fd0bb9d-570b-4719-bfae-93e2f879c19a",
"token_type": "BimPlus"
}

Revoke / Expire the token

GET

Resource: revoke?token=<token>

URL: https://api.bimplus.net/v2/revoke?token=<token>

Example:

The specified token will expire immediately.

Content-Type: application/json

Status: 200 OK

User Management Service

Create a new user

POST

Resource: users

URL: https://api.bimplus.net/v2/users

Example: https://api.bimplus.net/v2/users

JSON Structure:

Name	Mandatory / Optional	Type	Description
email	mandatory	string	Email of the user
status	optional	will be ignored	The status of the account (Active / Inactive)
password	mandatory	string	Password of the user

Creates a new user account.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

{
 "email" : "test@bimplus.net",
 "password" : "test"
}

Status: 201 Created

{
    "id": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6",
    "email": "test@bimplus.net",
    "status": "Active"
}

Get information about the user

GET

Resource: users/<user_id>

URL: https://api.bimplus.net/v2/users/<user_id>

Example: https://api.bimplus.net/v2/users/b8615afc-99cc-4bcd-b0ca-ff0593ce15c6

Get information about a specified user.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Status: 200 OK

{
    "id": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6",
    "email": "test@bimplus.net",
    "status": "Active"
}

Update information about the user

PUT

Resource: users/<user_id>

URL: https://api.bimplus.net/v2/users/<user_id>

Example: https://api.bimplus.net/v2/users/b8615afc-99cc-4bcd-b0ca-ff0593ce15c6

JSON Structure:

Name	Mandatory / Optional	Type	Description
email	mandatory	string	Email of the user
status	mandatory	string	The status of the account (Active / Inactive)
password	mandatory	string	Password of the user

Update information about a specified user.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

{
    "email": "updated_test@bimplus.net",
    "status": "Active",
    "password": "test"
}

Status: 200 OK

Get information about the currently logged in user

GET

Resource: user

URL: https://api.bimplus.net/v2/user

Get information about the currently logged in user.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Status: 200 OK

{
    "id": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6",
    "email": "test@bimplus.net",
    "status": "Active"
}

Team Management Service

Create a new team and its related database

POST

Resource: teams

URL: https://api.bimplus.net/v2/teams

JSON Structure:

Name	Mandatory / Optional	Type	Description
slug	mandatory	string	The unique name which will be used in the url
name	mandatory	string	Name of the team
owner	mandatory	string (guid)	The unique identifier of the user who will be the initial owner
totalStorage	mandatory	integer	The total storage allocated to the the team (the initial storage size as ordered in the shop)
storageStats	will be ignored	integer	The storage statistics of the team
status	will be ignored	string	Active / Inactive
teamWorksConnection	optional	string	Base64 encoded database connection string for legacy applications
dataStorageStatus	optional	string	Online / Offline

Create a new team and its related database.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

{

        "slug": "best-company",
        "name": "Best Company",
        "owner": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6",
        "totalStorage": 500000000,
        "teamWorksConnection": "RGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0O0luaXRpYWwgQ2F0YWxvZz1CaW1QbHVzLlRlbmFudC5BTUFaT05BLU1OVU8wMTcudGhlLWJlc3Q7VXNlciBJRD10aGUtYmVzdDtQYXNzd29yZD00YmZhZWVlZTM5NDBmZjI0ZjhhNjg2MmIxMzk3NzUyYWU1MjlkZDIzO0Nvbm5lY3QgVGltZW91dD0xMA==",
        "dataStorageStatus": "Online"
    }

Status: 201 Created

{
    "id": "db038754-2598-4616-9ea2-2c0947f2e93a",
    "slug": "best-company",
    "name": "Best Company",
    "owner": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6",
    "totalStorage": 500000000,
    "storageStats": {
        "usedSpace": 0,
        "numberOfProjects": 0,
        "numberOfMembers": 0,
        "totalSpace": 500000000,
        "totalNumberOfProjects": 0,
        "totalNumberOfMembers": 0
    },
    "status": "Active",
    "teamWorksConnection": "RGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0O0luaXRpYWwgQ2F0YWxvZz1CaW1QbHVzLlRlbmFudC5BTUFaT05BLU1OVU8wMTcudGhlLWJlc3Q7VXNlciBJRD10aGUtYmVzdDtQYXNzd29yZD00YmZhZWVlZTM5NDBmZjI0ZjhhNjg2MmIxMzk3NzUyYWU1MjlkZDIzO0Nvbm5lY3QgVGltZW91dD0xMA==",
    "dataStorageStatus": "Online"
}

Get information about the team

GET

Resource: teams/<team_slug>

URL: https://api.bimplus.net/v2/teams/<team_slug>

Example: https://api.bimplus.net/v2/teams/best-company

Get information about a specified team.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Status: 200 OK

{
    "id": "33b7d02a-8c97-460e-9bf2-4959937fd2c5",
    "slug": "best-company",
    "name": "Best Company",
    "owner": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6",
    "totalStorage": 500000000,
    "storageStats": {
        "usedSpace": 13369344,
        "numberOfProjects": 0,
        "numberOfMembers": 0,
        "totalSpace": 500000000,
        "totalNumberOfProjects": 0,
        "totalNumberOfMembers": 0
    },
    "status": "Active",
    "teamWorksConnection": "RGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0O0luaXRpYWwgQ2F0YWxvZz1CaW1QbHVzLlRlbmFudC5BTUFaT05BLU1OVU8wMTcuYmVzdC1jb21wYW55O1VzZXIgSUQ9YmVzdC1jb21wYW55O1Bhc3N3b3JkPWFjNzZmMjM1MzJkMGI5ZjE0ZTYzNmRmMWVmZDAwNmMyMDM2ZGU4NWM7Q29ubmVjdCBUaW1lb3V0PTEw",
    "dataStorageStatus": "Online"
}

Update information about the team

PUT

Resource: teams/<team_slug>

URL: https://api.bimplus.net/v2/teams/<team_slug>

Example: https://api.bimplus.net/v2/teams/best-company

JSON Structure:

Name	Mandatory / Optional	Type	Description
slug	will be ignored	string	The unique name which will be used in the url
name	mandatory	string	Name of the team
owner	will be ignored	string (guid)	The unique identifier of the user who will be the initial owner
totalStorage	mandatory	integer	The total storage allocated to the the team (the initial storage size as ordered in the shop)
storageStats	will be ignored	integer	The storage statistics of the team
status	mandatory	string	Active / Inactive
teamWorksConnection	will be ignored	string	Base64 encoded database connection string for legacy applications
dataStorageStatus	will be ignored	string	Online / Offline

Update information about a specified team.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

{
        "name": "Best Company",
        "totalStorage": 500000000,
        "status": "Active"
}

Status: 200 OK

Delete the team

DELETE

Resource: teams/<team_slug>

URL: https://api.bimplus.net/v2/teams/<team_id>

Example: https://api.bimplus.net/v2/teams/08b8195a-a2ad-11e2-9993-002215ea7d6b

Delete a specified team.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Status: 200 OK

Get the team list in which the current logged in user is a member of

GET

Resource: teams

URL: https://api.bimplus.net/v2/teams

Get a team list in which the current logged in user is a member of

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Status: 200 OK

[
    {
        "id": "db038754-2598-4616-9ea2-2c0947f2e93a",
        "slug": "best-company",
        "name": "Best Company",
        "owner": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6",
        "totalStorage": 500000000,
        "storageStats": null,
        "status": "Active",
        "teamWorksConnection": "RGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0O0luaXRpYWwgQ2F0YWxvZz1CaW1QbHVzLlRlbmFudC5BTUFaT05BLU1OVU8wMTcudGhlLWJlc3Q7VXNlciBJRD10aGUtYmVzdDtQYXNzd29yZD00YmZhZWVlZTM5NDBmZjI0ZjhhNjg2MmIxMzk3NzUyYWU1MjlkZDIzO0Nvbm5lY3QgVGltZW91dD0xMA==",
        "dataStorageStatus": "Online"
    },
    {
        "id": "82884f54-96bf-4e9c-a2fb-44db8379378d",
        "slug": "nemetschek",
        "name": "Nemetschek",
        "owner": "132a78a5-b523-4bf2-8382-7098fac3f803",
        "totalStorage": 0,
        "storageStats": null,
        "status": "Active",
        "teamWorksConnection": "RGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0OyBJbml0aWFsIENhdGFsb2c9QmltUGx1cy5UZW5hbnQuRGV2OyBVc2VyIElkPWRiYmltbWFudHJvdGVzdDsgUGFzc3dvcmQ9MWprdGNudG9DcU9qeGtIMU9QOXg7IENvbm5lY3QgdGltZW91dD0xMA==",
        "dataStorageStatus": "Online"
    },
    {
        "id": "7eab1453-a4e7-4d05-983e-031544540e6f",
        "slug": "bimplus-demo",
        "name": "BimPlusDemo",
        "owner": "5592c628-588e-f5c0-b08b-088d43de9209",
        "totalStorage": 53687091200,
        "storageStats": null,
        "status": "Active",
        "teamWorksConnection": "RGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0O0luaXRpYWwgQ2F0YWxvZz1CaW1QbHVzLlRlbmFudC5iaW1wbHVzLWRlbW87VXNlciBJRD1iaW1wbHVzLWRlbW87UGFzc3dvcmQ9YWI3ZDRmNDc5ZGM4YjI1Yjg2MDc0Y2ZmZTNiNDBjZmY2OWQwNzQ1YjtDb25uZWN0IFRpbWVvdXQ9MTA=",
        "dataStorageStatus": "Online"
    }
]

Membership Management Service

Add the user to the team

POST

Resource: <team_slug>/members

URL: https://api.bimplus.net/v2/<team_slug>/members

Example: https://api.bimplus.net/v2/best-company/members

JSON Structure:

Name	Mandatory / Optional	Type	Description
user	mandatory	object	Information of the user
user.id	mandatory	string	Id of the user
user.email	will be ignored	string	Email of the user
user.status	will be ignored	string	Status of the user(Active / Inactive)
roles	will be ignored	object	Roles of the user
status	mandatory	string	Status of the membership(Active / Passive)

Add a specified user to a specified team.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

{
    "user": {
        "id": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6"
    },
    "roles": [
        "Member"
    ],
    "status": "Active"

}

Status: 200 Ok

Get the member list of the team

GET

Resource: <team_slug>/members

URL: https://api.bimplus.net/v2/<team_slug>/members

Example: https://api.bimplus.net/v2/best-company/members

Gets the member list of a specified team.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Status: 200 OK

[
    {
        "user": {
            "id": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6",
            "email": "test@bimplus.net",
            "status": "Active"
        },
        "roles": [
            "Member"
        ],
        "status": "Active"
    },
    {
        "user": {
            "id": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c7",
            "email": "customer@bimplus.net",
            "status": "Active"
        },
        "roles": [
            "Member"
        ],
        "status": "Passive"
    }
]

Update information about the user in the team

PUT

Resource: <team_slug>/members/<user_id>

URL: https://api.bimplus.net/v2//members/

Example: https://api.bimplus.net/v2/best-company]>/members/b8615afc-99cc-4bcd-b0ca-ff0593ce15c6

JSON Structure:

Name	Mandatory / Optional	Type	Description
user	mandatory	object	Information of the user
user.id	mandatory	string	Id of the user
status	mandatory	string	Status of the membership(Active / Passive)

Update information about a specified user in a team.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

{
        "user": {
            "id": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c7"
        },
        "status": "Active"
    }

Status: 200 OK

Delete the user from the team

DELETE

Resource: <team_slug>/members/<user_id>

URL: https://api.bimplus.net/v2//members/

Example: https://api.bimplus.net/v2/best-company/members/b8615afc-99cc-4bcd-b0ca-ff0593ce15c6

Deletes a specified user from a team.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Status: 200 OK