4. Bimplus API Reference

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

Developers please use https://api-stage.bimplus.net/v2 (stage version of Bimplus API) and https://www-stage.bimplus.net/ (stage version of Shop/Portal) for testing purposes. Please use these login details(Login: bimplus, password: Bimplus) if you receive a login dialog before our portal loads. The production version of the portal is located under https://bimplus.net/ and the base url of the API is different for the production version.

Project relevant services

Administration relevant services

Other services

Model Service

Object Service

Structure Service

Clash Service

D etect the clashes in a project

Authorization Service

User Management Service

Team Management Service

Membership Management Service

Rights & Roles Service

Messaging Service

Log Service

Bimplus Windows Explorer related Services

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

Resource: element-types

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

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

GET

Gets the list of existing element types.

Headers

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

Status

Status: 200 OK

JSON

[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

Resource: element-types/<element_type_id>

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

Example: https://api-stage.bimplus.net/v2/bimplus/element-types/e504f24c-e643-452b-b901-6a18883dc7e9

GET

Get the properties of a specified element type.

Headers

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

Status

Status: 200 OK

JSON

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

Get the list of existing layers

Resource: element-types/disciplines

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

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

GET

Gets the list of existing layers.

Headers

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

Status

Status: 200 OK

JSON

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

Attachment Service

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

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

Get Attachment information

Resource: attachments/<attachment_id>

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

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

GET

Get detailed information about a specified attachment.

Headers

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

Status

Status: 200 OK

JSON

    {
        "objectIds": [
            "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
        ],
        "fileName": "Building_Plan.jpg",
        "type": "image/jpeg",
        "size": 211258,
        "createdAt": "2013-12-11T10:47:39",
        "creator": {
        "id": "e18941f4-a809-2d01-d27d-cd251f2b6cb6",
        "email": "test@bimplus.net",
        "firstname": "First Name",
        "lastname": "Second Name",
        "company": "Best-Company",
        "fullname": "First Name Second Name",
        "displayname": "Best-Company",
        "info": "",
        "gender": "",
        "phoneWork": "",
        "phoneHome": "",
        "fax": "",
        "mobile": "",
        "birthDate": "0000-00-00",
        "address": {
            "street": "Westermeier str.",
            "streetNr": "10",
            "zip": "81829",
            "city": "München",
            "country": "Germany"
        },
        "preferedLanguage": "en"
       },
        "id": "6cea110a-88f4-43ac-9a00-ebaf677be333"
    }

Download the attachment

Resource: attachments/<attachment_id>/download

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

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

GET

Download the content of a specified attachment. There also exists a POST method for downloading the attachment where you have to pass the "token" as a form parameter.

Headers

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

Status

Status: 200 OK

Update the attachment

Resource: attachments/<attachment_id>

URL: https://api-stage.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
createdAt	will be ignored	string	Creation date of the attachment
creator	will be ignored	object	The user who created the attachment

GET

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

Headers

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

Status

Status: 200 OK

Delete the Attachment

Resource: attachments/<attachment_id>

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

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

GET

Deletes a specified attachment.

Headers

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

Status

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

Resource: issues/<issue_id>

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

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

GET

Get details of an issue present in a project.

Headers

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

Status

Status: 200 OK

JSON

{
    "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)

Resource: issues/types

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

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

GET

Get all the available issue types.

Headers

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

Status

Status: 200 OK

Get details of the issue type (Not implemented)

Resource: issues/types/<type_id>

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

GET

Get details of a specified issue type.

Headers

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

Status

Status: 200 OK

Create a new pin for the issue

Resource: issues/<issue_id>/pins

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

Example: https://api-stage.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	Creation date of the pin

POST

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

Headers

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

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

Status: 201 Created

JSON

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

Resource: issues/<issue_id>/pins

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

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

GET

Get all the pins of a specified issue type.

Headers

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

Status

Status: 200 OK

JSON

[
    {
        "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

Resource: issues/<issue_id>/pins

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

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

DELETE

Delete all the pins from a specified issue.

Headers

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

Status

Status: 200 OK

Create a new comment for the issue

Please note that you can also use the Bimplus Object Service for working with the comments belonging to an issue

Resource: issues/<issue_id>/comments

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

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

JSON Structure:

Name	Mandatory / Optional	Type	Description
issueId	will be ignored	string(guid)	The id of the issue
text	mandatory	string	The comment text
createdAt	will be ignored	string (date)	Creation date of the comment
modifiedAt	will be ignored	string (date)	Modified date of the comment
author	will be ignored	object	The author of the comment

POST

Create a new comment for a specified issue.

Headers

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

JSON

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

Status

Status: 201 Created

JSON

{
    "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": {
        "id": "00000000-0000-0000-0000-000000000000",
        "email": "",
        "firstname": "Unknown",
        "lastname": "User",
        "company": "",
        "fullname": "Unknown User",
        "displayname": "Unknown User",
        "info": "",
        "gender": "",
        "phoneWork": "",
        "phoneHome": "",
        "fax": "",
        "mobile": "",
        "birthDate": "0000-00-00",
        "address": {
            "street": "",
            "streetNr": "",
            "zip": "",
            "city": "",
            "country": ""
        },
        "preferedLanguage": null
    },
    "id": "d258c905-c8af-4463-b0d8-ac09dbcfc255"
}

Get all the comments of the issue

Resource: issues/<issue_id>/comments

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

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

GET

Get all the comments of a specified issue.

Headers

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

Status

Status: 200 OK

JSON

[
    {
        "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",
        "modifiedAt": "2013-07-03T13:26:18+00:00",
        "author": {
        "id": "00000000-0000-0000-0000-000000000000",
        "email": "",
        "firstname": "Unknown",
        "lastname": "User",
        "company": "",
        "fullname": "Unknown User",
        "displayname": "Unknown User",
        "info": "",
        "gender": "",
        "phoneWork": "",
        "phoneHome": "",
        "fax": "",
        "mobile": "",
        "birthDate": "0000-00-00",
        "address": {
            "street": "",
            "streetNr": "",
            "zip": "",
            "city": "",
            "country": ""
        },
        "preferedLanguage": null
    },
        "id": "d258c905-c8af-4463-b0d8-ac09dbcfc255"
    }
]

Delete all the comments from the issue

Resource: issues/<issue_id>/comments

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

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

DELETE

Delete all the comments from the issue.

Headers

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

Status

Status: 200 OK

Create a new attachment for the issue

Please note that you can also use the Bimplus Object Service for working with the attachments belonging to an issue

Resource: issues/<issue_id>/attachments

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

Example:https://api-stage.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
createdAt	will be ignored	string	Creation date of the attachment
creator	will be ignored	object	The user who created the attachment

POST

Creates a new attachment for a specified issue.

Headers

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

Status

Status: 201 Created

JSON

    {
        "objectIds": [
            "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
        ],
        "fileName": "Building_Plan.jpg",
        "type": "image/jpeg",
        "size": 211258,
        "createdAt": "2013-12-11T10:47:39",
        "creator": {
        "id": "e18941f4-a809-2d01-d27d-cd251f2b6cb6",
        "email": "test@bimplus.net",
        "firstname": "First Name",
        "lastname": "Second Name",
        "company": "Best-Company",
        "fullname": "First Name Second Name",
        "displayname": "Best-Company",
        "info": "",
        "gender": "",
        "phoneWork": "",
        "phoneHome": "",
        "fax": "",
        "mobile": "",
        "birthDate": "0000-00-00",
        "address": {
            "street": "Westermeier str.",
            "streetNr": "10",
            "zip": "81829",
            "city": "München",
            "country": "Germany"
        },
        "preferedLanguage": "en"
       },
        "id": "6cea110a-88f4-43ac-9a00-ebaf677be333"
    }

Get the attachment list from the issue

Resource: issues/<issue_id>/attachments

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

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

GET

Gets the attachment list from a specified issue.

Headers

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

Status

Status: 200 OK

JSON

    {
        "objectIds": [
            "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
        ],
        "fileName": "Building_Plan.jpg",
        "type": "image/jpeg",
        "size": 211258,
        "createdAt": "2013-12-11T10:47:39",
        "creator": {
        "id": "e18941f4-a809-2d01-d27d-cd251f2b6cb6",
        "email": "test@bimplus.net",
        "firstname": "First Name",
        "lastname": "Second Name",
        "company": "Best-Company",
        "fullname": "First Name Second Name",
        "displayname": "Best-Company",
        "info": "",
        "gender": "",
        "phoneWork": "",
        "phoneHome": "",
        "fax": "",
        "mobile": "",
        "birthDate": "0000-00-00",
        "address": {
            "street": "Westermeier str.",
            "streetNr": "10",
            "zip": "81829",
            "city": "München",
            "country": "Germany"
        },
        "preferedLanguage": "en"
       },
        "id": "6cea110a-88f4-43ac-9a00-ebaf677be333"
    }

Delete all the attachments from the issue

Resource: issues/<issue_id>/attachments

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

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

DELETE

Delete all the attachments from a specified issue.

Headers

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

Status

Status: 200 OK

Working with hyperlinks belonging to an issue

Please use the Bimplus Object Service for working with hyperlinks belonging to an issue

Update the issue

Resource: issues/<issue_id>

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

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

JSON Structure:

Name	Mandatory / Optional	Type	Description
shortId	will be ignored	number	Readable unique issue number(always starts with 1 for each project)
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	object	Author of the issue
responsible	optional	object	Responsible person for the issue
status	optional	string	Status of the issue. Should have one of the values: Open, Solved or Closed
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. Should have one of the values: Low, Medium or High

PUT

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

Headers

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

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

Status: 200 OK

Delete the issue

Resource: issues/<issue_id>

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

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

DELETE

Deletes a specified issue.

Headers

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

Status

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 a pin or for getting/deleting all the pins assigned to an issue

Get details of the pin

Resource: pins/<pin_id>

URL: https://api-stage.bimplus.net/v2/<team_slug>/pins/<pin_id>

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

GET

Get details of a specified pin.

Headers

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

Status

Status: 200 OK

JSON

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

Resource: pins/<pin_id>

URL: https://api-stage.bimplus.net/v2/<team_slug>/pins/<pin_id>

Example: https://api-stage.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	Creation date of the pin

PUT

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

Headers

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

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

Status: 200 OK

Delete the pin

Resource: pins/<pin_id>

URL: https://api-stage.bimplus.net/v2/<team_slug>/pins/<pin_id>

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

DELETE

Deletes a specified pin.

Headers

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

Status

Status: 200 OK

Comment Service

A particular comment belonging to an issue can be modified using the comment service.

Please use the Bimplus Object Service or Bimplus Issue Service for creating a comment or to deal with the group of comments belonging to an object, issue or slide.

Get details of the comment

Resource: comments/<comment_id>

URL: https://api-stage.bimplus.net/v2/<team_slug>/comments/<comment_id>

Example:https://api-stage.bimplus.net/v2/bimplus/comments/db540336-47a3-426e-b3bf-1e532bfac8ea

GET

Get details of a specified comment.

Headers

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

Status

Status: 200 OK

JSON

{
    "issueId": "8415bd8d-7e27-4975-bddb-b1b365719770",
    "text": "Second Comment: The fire exit should be x:120, y: 120; z: 340",
    "createdAt": "2013-11-20T08:17:36+00:00",
    "modifiedAt": "2013-11-20T08:17:36+00:00",
    "author": {
        "id": "132a78a5-b523-4bf2-8382-7098fac3f803",
        "email": "test@bimplus.net",
        "status": "Active",
        "firstname": null,
        "lastname": null,
        "company": null,
        "displayname": null,
        "info": null,
        "gender": null,
        "phoneWork": null,
        "phoneHome": null,
        "fax": null,
        "mobile": null,
        "birthDate": null,
        "address": {
            "street": "",
            "streetNr": "",
            "zip": "",
            "city": "",
            "country": ""
        },
        "preferedLanguage": null
    },
    "id": "db540336-47a3-426e-b3bf-1e532bfac8ea"
}

Update the comment

Resource: comments/<comment_id>

URL: https://api-stage.bimplus.net/v2/<team_slug>/comment/<comment_id>

Example: https://api-stage.bimplus.net/v2/bimplus/comments/db540336-47a3-426e-b3bf-1e532bfac8ea

JSON Structure:

Name	Mandatory / Optional	Type	Description
issueId	will be ignored	string(guid)	The id of the issue
text	mandatory	string	The comment text
createdAt	will be ignored	string (date)	Creation date of the comment
modifiedAt	will be ignored	string (date)	Modified date of the comment
author	optional	object	The author of the comment

PUT

Update the specified comment.

Headers

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

JSON

{
    "issueId": "8415bd8d-7e27-4975-bddb-b1b365719770",
    "text": "Second Comment: The fire exit should be x:120, y: 120; z: 340",
    "createdAt": "2013-11-20T08:17:36+00:00",
    "modifiedAt": "2013-11-20T08:17:36+00:00",
    "author": {
        "id": "132a78a5-b523-4bf2-8382-7098fac3f803"
    }
}

Status

Status: 200 OK

Delete the comment

Resource: comments/<comment_id>

URL: https://api-stage.bimplus.net/v2/<team_slug>/comments/<comment_id>

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

DELETE

Deletes a specified comment.

Headers

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

Status

Status: 200 OK

Import Service

This service is used for replacing existing models inside a project by importing the models in the form of IFC and SketchUp files. So, for using this service the model should exist first (which could be either created through the Model Service or the Bimplus portal)

Replace a model by importing SketchUp and IFC files

Resource: import

URL: https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/model/<model_id>/importasync

Example: https://api-stage.bimplus.net/v2/bimplus/projects/best-project/model/12345/importasync

POST

Replace a model in a project by importing SketchUp and IFC files.

Headers

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

Status

Status: 201 Created

Slideshow Service

A Slideshow is a group of slides(camera snapshots) attached to a project.

Create a new slideshow

Resource: slideshows

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

Example: https://api-stage.bimplus.net/v2/bimplus/projects/5cd37c77-d341-4ab2-9f0d-44467955/slideshows

JSON Structure:

Name	Mandatory / Optional	Type	Description
name	mandatory	string	Name of the slideshow
description	optional	string	Description of the slideshow
projectId	will be ignored	string	The id of the project to which the slideshow belongs
author	will be ignored	object (user)	Information about the user who has created the slideshow
created	will be ignored	string (date)	Creation date of the slideshow
id	will be ignored	string (id)	Id of the slideshow

POST

Creates a new slideshow for a project.

Headers

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

JSON

{
 "name": "My first slideshow"
}

Status

Status: 201 Created

JSON

{
    "projectId": "5cd37c77-d341-4ab2-9f0d-44467955b218",
    "name": "My first slideshow",
    "description": null,
    "author": {
        "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
        "email": "jayaraj.purushothaman@gmail.com",
        "firstname": "Jayaraj",
        "lastname": "Purushothaman",
        "company": "Jay Company",
        "fullname": "Jayaraj Purushothaman",
        "displayname": "Jayaraj Purushothaman [Jay Company]",
        "info": "",
        "gender": "MR",
        "phoneWork": "",
        "phoneHome": "",
        "fax": "",
        "mobile": "",
        "birthDate": "0000-00-00",
        "address": {
            "street": "Konrad Zuse platz",
            "streetNr": "1",
            "zip": "81829",
            "city": "Munich",
            "country": "Germany"
        },
        "preferedLanguage": "en"
    },
    "created": "2014-03-06T09:43:00.0929712Z",
    "id": "30f4495a-79d7-48e4-8060-8a52350cfcd9"
}

Get the slideshow list from a project

Resource: slideshows

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

Example: https://api-stage.bimplus.net/v2/bimplus/projects/5cd37c77-d341-4ab2-9f0d-44467955/slideshows

GET

Get the slideshow list belonging to a project.

Headers

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

Status

Status: 200 OK

JSON

[
    {
        "projectId": "5cd37c77-d341-4ab2-9f0d-44467955b218",
        "name": "My first slideshow",
        "description": null,
        "author": {
            "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "jayaraj.purushothaman@gmail.com",
            "firstname": "Jayaraj",
            "lastname": "Purushothaman",
            "company": "Jay Company",
            "fullname": "Jayaraj Purushothaman",
            "displayname": "Jayaraj Purushothaman [Jay Company]",
            "info": "",
            "gender": "MR",
            "phoneWork": "",
            "phoneHome": "",
            "fax": "",
            "mobile": "",
            "birthDate": "0000-00-00",
            "address": {
                "street": "Konrad Zuse platz",
                "streetNr": "1",
                "zip": "81829",
                "city": "Munich",
                "country": "Germany"
            },
            "preferedLanguage": "en"
        },
        "created": "2014-03-06T09:43:00",
        "id": "30f4495a-79d7-48e4-8060-8a52350cfcd9"
    }
]

Delete all the slideshows from a project

Resource: slideshows

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

Example: https://api-stage.bimplus.net/v2/bimplus/projects/5cd37c77-d341-4ab2-9f0d-44467955/slideshows

DELETE

Delete all the slideshows from a project

Headers

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

Status

Status: 200 OK

Get details of the slideshow

Resource: slideshows/<slideshow_id>

URL: https://api-stage.bimplus.net/v2/<team_slug>/slideshows/<slideshow_id>

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

GET

Get the details of a particular slideshow using its id.

Headers

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

Status

Status: 200 OK

JSON

{
    "projectId": "5cd37c77-d341-4ab2-9f0d-44467955b218",
    "name": "My first slideshow",
    "description": null,
    "author": {
        "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
        "email": "jayaraj.purushothaman@gmail.com",
        "firstname": "Jayaraj",
        "lastname": "Purushothaman",
        "company": "Jay Company",
        "fullname": "Jayaraj Purushothaman",
        "displayname": "Jayaraj Purushothaman [Jay Company]",
        "info": "",
        "gender": "MR",
        "phoneWork": "",
        "phoneHome": "",
        "fax": "",
        "mobile": "",
        "birthDate": "0000-00-00",
        "address": {
            "street": "Konrad Zuse platz",
            "streetNr": "1",
            "zip": "81829",
            "city": "Munich",
            "country": "Germany"
        },
        "preferedLanguage": "en"
    },
    "created": "2014-03-03T15:31:14",
    "id": "ff375edf-5e8c-4b68-a4a1-fec6b943e7d8"
}

Update the slideshow

Resource: slideshows/<slideshow_id>

URL: https://api-stage.bimplus.net/v2/<team_slug>/slideshows/<slideshow_id>

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

JSON Structure:

Name	Mandatory / Optional	Type	Description
name	optional	string	Name of the slideshow
description	optional	string	Description of the slideshow
projectId	optional	string	The id of the project to which the slideshow belongs
author	will be ignored	object (user)	Information about the user who has created the slideshow
created	will be ignored	string (date)	Creation date of the slideshow
id	will be ignored	string (id)	Id of the slideshow

PUT

Update a specific slideshow using its id.

Headers

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

JSON

{
    "projectId": "5cd37c77-d341-4ab2-9f0d-44467955b218",
    "name": "Updating my first slideshow",
    "description": null,
    "author": {
        "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed"
    }
}

Status

Status: 200 OK

JSON

{
    "projectId": "5cd37c77-d341-4ab2-9f0d-44467955b218",
    "name": "Updating my first slideshow",
    "description": null,
    "author": {
        "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
        "email": null,
        "firstname": null,
        "lastname": null,
        "company": null,
        "fullname": "",
        "displayname": null,
        "info": null,
        "gender": null,
        "phoneWork": null,
        "phoneHome": null,
        "fax": null,
        "mobile": null,
        "birthDate": null,
        "address": {
            "street": "",
            "streetNr": "",
            "zip": "",
            "city": "",
            "country": ""
        },
        "preferedLanguage": null
    },
    "created": "0001-01-01T00:00:00",
    "id": "ff375edf-5e8c-4b68-a4a1-fec6b943e7d8"
}

Delete the slideshow

Resource: slideshows/<slideshow_id>

URL: https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/slideshows/<slideshow_id>

Example: https://api-stage.bimplus.net/v2/bimplus/projects/5cd37c77-d341-4ab2-9f0d-44467955/slideshows/ff375edf-5e8c-4b68-a4a1-fec6b943e7d8

DELETE

Delete a particular slideshow using its id.

Headers

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

Status

Status: 200 OK

Create a new slide for a slideshow

Resource: slideshows/<slideshow_id>/slides

URL: https://api-stage.bimplus.net/v2/<team_slug>/slideshows/<slideshow_id>/slides

Example: https://api-stage.bimplus.net/v2/bimplus/slideshows/30f4495a-79d7-48e4-8060-8a52350cfcd9/slides

JSON Structure:

Name	Mandatory / Optional	Type	Description
name	optional	string	Name of the slide
description	optional	string	Description of the slide
slideInfo	optional	string
scene	optional	object	A JSON string which includes viewMode(transparent or not), camera values & positions, related objects, clipping plane, topology & layer details. An example template is specified below. Please remember, the server will process the scene information as a json string and hence the client has to take care on the information that is stored & retrieved.
author	will be ignored	object (user)	Information about the user who has created the slide
created	will be ignored	string (date)	Creation date of the slide
id	will be ignored	string (id)	Id of the slide
index	will be ignored	integer	Order of the slides (Starts with 1)

An example scene template:

"scene": {
    "viewMode": "transparent",
    "camera": {
        "fov": 45,
        "position": {
            "x": 1231.4,
            "y": 234.3,
            "z": 3123.7
        },
        "quaternion": {
            "x": 0.9,
            "y": 0.7,
            "z": 0.7,
            "w": 0.23
        },
        "target": {
            "objectId": "<GUID>",
            "position": {
                "x": 1231.4,
                "y": 234.3,
                "z": 3123.7
            }
        }
    },
    "objects": {
        "selected": [
            0,
            1,
            2,
            3,
            4,
            5,
            6,
            7,
            8,
            9
        ],
        "transparent": [
            0,
            1,
            2,
            3,
            4,
            5,
            6,
            7,
            8,
            9
        ],
        "hidden": [
            0,
            1,
            2,
            3,
            4,
            5,
            6,
            7,
            8,
            9
        ]
    },
    "clippingPlane": {
        "axis": "x",
        "distance": -123.5,
        "selected": false
    },
    "topology": [
        [
            "<nodeId>",
            "<disciplineId>"
        ],
        [
            "<nodeId2>",
            "<disciplineId2>"
        ]
    ],
    "layers": [
        {
            "id": "<GUID>",
            "divisionTopologyId": "<GUID>",
            "visible": true,
            "transparent": false
        }
    ]
}

POST

Creates a new slide for a specific slideshow.

Headers

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

JSON

{
    "name": "My first slide",
    "scene": {
        "viewMode": "transparent",
        "camera": {
            "fov": 45,
            "position": {
                "x": 1231.4,
                "y": 234.3,
                "z": 3123.7
            },
            "quaternion": {
                "x": 0.9,
                "y": 0.7,
                "z": 0.7,
                "w": 0.23
            },
            "target": {
                "objectId": "<GUID>",
                "position": {
                    "x": 1231.4,
                    "y": 234.3,
                    "z": 3123.7
                }
            }
        },
        "objects": {
            "selected": [
                0,
                1,
                2,
                3,
                4,
                5,
                6,
                7,
                8,
                9
            ],
            "transparent": [
                0,
                1,
                2,
                3,
                4,
                5,
                6,
                7,
                8,
                9
            ],
            "hidden": [
                0,
                1,
                2,
                3,
                4,
                5,
                6,
                7,
                8,
                9
            ]
        },
        "clippingPlane": {
            "axis": "x",
            "distance": -123.5,
            "selected": false
        },
        "topology": [
            [
                "<nodeId>",
                "<disciplineId>"
            ],
            [
                "<nodeId2>",
                "<disciplineId2>"
            ]
        ],
        "layers": [
            {
                "id": "<GUID>",
                "divisionTopologyId": "<GUID>",
                "visible": true,
                "transparent": false
            }
        ]
    }
}

Status

Status: 201 Created

JSON

{
    "name": "My first slide",
    "description": null,
    "slideInfo": "",
    "index": 1,
    "scene": {
        "viewMode": "transparent",
        "camera": {
            "fov": 45,
            "position": {
                "x": 1231.4,
                "y": 234.3,
                "z": 3123.7
            },
            "quaternion": {
                "x": 0.9,
                "y": 0.7,
                "z": 0.7,
                "w": 0.23
            },
            "target": {
                "objectId": "<GUID>",
                "position": {
                    "x": 1231.4,
                    "y": 234.3,
                    "z": 3123.7
                }
            }
        },
        "objects": {
            "selected": [
                0,
                1,
                2,
                3,
                4,
                5,
                6,
                7,
                8,
                9
            ],
            "transparent": [
                0,
                1,
                2,
                3,
                4,
                5,
                6,
                7,
                8,
                9
            ],
            "hidden": [
                0,
                1,
                2,
                3,
                4,
                5,
                6,
                7,
                8,
                9
            ]
        },
        "clippingPlane": {
            "axis": "x",
            "distance": -123.5,
            "selected": false
        },
        "topology": [
            [
                "<nodeId>",
                "<disciplineId>"
            ],
            [
                "<nodeId2>",
                "<disciplineId2>"
            ]
        ],
        "layers": [
            {
                "id": "<GUID>",
                "divisionTopologyId": "<GUID>",
                "visible": true,
                "transparent": false
            }
        ]
    },
    "created": "2014-03-06T09:52:58.4376633Z",
    "author": {
        "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
        "email": "jayaraj.purushothaman@gmail.com",
        "firstname": "Jayaraj",
        "lastname": "Purushothaman",
        "company": "Jay Company",
        "fullname": "Jayaraj Purushothaman",
        "displayname": "Jayaraj Purushothaman [Jay Company]",
        "info": "",
        "gender": "MR",
        "phoneWork": "",
        "phoneHome": "",
        "fax": "",
        "mobile": "",
        "birthDate": "0000-00-00",
        "address": {
            "street": "Konrad Zuse platz",
            "streetNr": "1",
            "zip": "81829",
            "city": "Munich",
            "country": "Germany"
        },
        "preferedLanguage": "en"
    },
    "id": "60c23ad7-c4b6-4387-b273-1dff2b1dc895"
}

Get the slide list from a slideshow

Resource: slideshows/<slideshow_id>/slides

URL: https://api-stage.bimplus.net/v2/<team_slug>/slideshows/<slideshow_id>/slides

Example: https://api-stage.bimplus.net/v2/bimplus/slideshows/30f4495a-79d7-48e4-8060-8a52350cfcd9/slides

GET

Get the slide list belonging to a slideshow

Headers

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

Status

Status: 200 OK

JSON

[
    {
        "name": "My first slide",
        "description": null,
        "slideInfo": "",
        "index": 1,
        "scene": {
            "viewMode": "transparent",
            "camera": {
                "fov": 45,
                "position": {
                    "x": 1231.4,
                    "y": 234.3,
                    "z": 3123.7
                },
                "quaternion": {
                    "x": 0.9,
                    "y": 0.7,
                    "z": 0.7,
                    "w": 0.23
                },
                "target": {
                    "objectId": "<GUID>",
                    "position": {
                        "x": 1231.4,
                        "y": 234.3,
                        "z": 3123.7
                    }
                }
            },
            "objects": {
                "selected": [
                    0,
                    1,
                    2,
                    3,
                    4,
                    5,
                    6,
                    7,
                    8,
                    9
                ],
                "transparent": [
                    0,
                    1,
                    2,
                    3,
                    4,
                    5,
                    6,
                    7,
                    8,
                    9
                ],
                "hidden": [
                    0,
                    1,
                    2,
                    3,
                    4,
                    5,
                    6,
                    7,
                    8,
                    9
                ]
            },
            "clippingPlane": {
                "axis": "x",
                "distance": -123.5,
                "selected": false
            },
            "topology": [
                [
                    "<nodeId>",
                    "<disciplineId>"
                ],
                [
                    "<nodeId2>",
                    "<disciplineId2>"
                ]
            ],
            "layers": [
                {
                    "id": "<GUID>",
                    "divisionTopologyId": "<GUID>",
                    "visible": true,
                    "transparent": false
                }
            ]
        },
        "created": "2014-03-06T09:52:58",
        "author": {
            "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "jayaraj.purushothaman@gmail.com",
            "firstname": "Jayaraj",
            "lastname": "Purushothaman",
            "company": "Jay Company",
            "fullname": "Jayaraj Purushothaman",
            "displayname": "Jayaraj Purushothaman [Jay Company]",
            "info": "",
            "gender": "MR",
            "phoneWork": "",
            "phoneHome": "",
            "fax": "",
            "mobile": "",
            "birthDate": "0000-00-00",
            "address": {
                "street": "Konrad Zuse platz",
                "streetNr": "1",
                "zip": "81829",
                "city": "Munich",
                "country": "Germany"
            },
            "preferedLanguage": "en"
        },
        "id": "60c23ad7-c4b6-4387-b273-1dff2b1dc895"
    }
]

Get the details of a slide

Resource: slides/<slide_id>

URL: https://api-stage.bimplus.net/v2/<team_slug>/slides/<slide_id>

Example: https://api-stage.bimplus.net/v2/bimplus/slides/60c23ad7-c4b6-4387-b273-1dff2b1dc895

GET

Get the details of a particular slide using its id.

Headers

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

Status

Status: 200 OK

JSON

{
    "name": "My first slide",
    "description": null,
    "slideInfo": "",
    "index": 1,
    "scene": {
        "viewMode": "transparent",
        "camera": {
            "fov": 45,
            "position": {
                "x": 1231.4,
                "y": 234.3,
                "z": 3123.7
            },
            "quaternion": {
                "x": 0.9,
                "y": 0.7,
                "z": 0.7,
                "w": 0.23
            },
            "target": {
                "objectId": "<GUID>",
                "position": {
                    "x": 1231.4,
                    "y": 234.3,
                    "z": 3123.7
                }
            }
        },
        "objects": {
            "selected": [
                0,
                1,
                2,
                3,
                4,
                5,
                6,
                7,
                8,
                9
            ],
            "transparent": [
                0,
                1,
                2,
                3,
                4,
                5,
                6,
                7,
                8,
                9
            ],
            "hidden": [
                0,
                1,
                2,
                3,
                4,
                5,
                6,
                7,
                8,
                9
            ]
        },
        "clippingPlane": {
            "axis": "x",
            "distance": -123.5,
            "selected": false
        },
        "topology": [
            [
                "<nodeId>",
                "<disciplineId>"
            ],
            [
                "<nodeId2>",
                "<disciplineId2>"
            ]
        ],
        "layers": [
            {
                "id": "<GUID>",
                "divisionTopologyId": "<GUID>",
                "visible": true,
                "transparent": false
            }
        ]
    },
    "created": "2014-03-06T09:52:58",
    "author": {
        "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
        "email": "jayaraj.purushothaman@gmail.com",
        "firstname": "Jayaraj",
        "lastname": "Purushothaman",
        "company": "Jay Company",
        "fullname": "Jayaraj Purushothaman",
        "displayname": "Jayaraj Purushothaman [Jay Company]",
        "info": "",
        "gender": "MR",
        "phoneWork": "",
        "phoneHome": "",
        "fax": "",
        "mobile": "",
        "birthDate": "0000-00-00",
        "address": {
            "street": "Konrad Zuse platz",
            "streetNr": "1",
            "zip": "81829",
            "city": "Munich",
            "country": "Germany"
        },
        "preferedLanguage": "en"
    },
    "id": "60c23ad7-c4b6-4387-b273-1dff2b1dc895"
}

Update the details of a slide

Resource: slides/<slide_id>

URL: https://api-stage.bimplus.net/v2/<team_slug>/slides/<slide_id>

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

JSON Structure:

Name	Mandatory / Optional	Type	Description
name	optional	string	Name of the slideshow
description	optional	string	Description of the slideshow
projectId	optional	string	The id of the project to which the slideshow belongs
author	will be ignored	object (user)	Information about the user who has created the slideshow
created	will be ignored	string (date)	Creation date of the slideshow
id	will be ignored	string (id)	Id of the slideshow
index	optional	integer	Order of the slide (Starts with 1)

PUT

Update a specific slideshow using its id.

Headers

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

JSON

{
    "projectId": "5cd37c77-d341-4ab2-9f0d-44467955b218",
    "name": "Updating my first slide",
    "description": null,
    "author": {
        "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed"
    }
}

Status

Status: 200 OK

JSON

{
    "projectId": "5cd37c77-d341-4ab2-9f0d-44467955b218",
    "name": "Updating my first slideshow",
    "description": null,
    "author": {
        "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
        "email": null,
        "firstname": null,
        "lastname": null,
        "company": null,
        "fullname": "",
        "displayname": null,
        "info": null,
        "gender": null,
        "phoneWork": null,
        "phoneHome": null,
        "fax": null,
        "mobile": null,
        "birthDate": null,
        "address": {
            "street": "",
            "streetNr": "",
            "zip": "",
            "city": "",
            "country": ""
        },
        "preferedLanguage": null
    },
    "created": "0001-01-01T00:00:00",
    "id": "ff375edf-5e8c-4b68-a4a1-fec6b943e7d8"
}

Delete a slide from a slideshow

Resource: slides/slide

URL: https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/slides/<slide_id>

Example: https://api-stage.bimplus.net/v2/bimplus/projects/5cd37c77-d341-4ab2-9f0d-44467955/slides/ff375edf-5e8c-4b68-a4a1-fec6b943e7d8

DELETE

Delete a particular slide using its id.

Headers

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

Status

Status: 200 OK

Create a thumbnail for a slideshow

Resource: slides/<slide_id>/thumbnail

URL: https://api-stage.bimplus.net/v2/<team_slug>/slideshows/<slideshow_id>/thumbnail

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

POST

Creates or uploads a thumbnail to a slideshow.

Headers

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

Status

Status: 201 Created

JSON

{
    "fileName": "Slideshow1.png",
    "type": "image/png",
    "size": 21320,
    "id": "60c23ad7-c4b6-4387-b273-1dff2b1dc895"
}

Download the thumbnail from a slideshow

Resource: slide/<slide_id>/thumbnail/download

URL: https://api-stage.bimplus.net/v2/<team_slug>/thumbnail/<thumbnail_id>

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

GET

Downloads the thumbnail of a slideshow.

Headers

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

Status

Status: 200 OK

Create a thumbnail for a slide

Resource: slides/<slide_id>/thumbnail

URL: https://api-stage.bimplus.net/v2/<team_slug>/slides/<slide_id>/thumbnail

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

POST

Creates or uploads a thumbnail to a slide.

Headers

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

Status

Status: 201 Created

JSON

{
    "fileName": "Slide1.png",
    "type": "image/png",
    "size": 21320,
    "id": "60c23ad7-c4b6-4387-b273-1dff2b1dc895"
}

Download the thumbnail from a slide

Resource: slide/<slide_id>/thumbnail/download

URL: https://api-stage.bimplus.net/v2/<team_slug>/thumbnail/>thumbnail_id>

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

GET

Downloads the thumbnail of a slide.

Headers

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

Status

Status: 200 OK

Working with attachments/comments/hyperlinks belonging to a slide

Please use the Bimplus Object Service for working with attachments, comments or hyperlinks belonging to a slide

Hyperlink Service

A particular hyperlink belonging to an object/slide/issue can be modified using the hyperlink service.

Please use the Bimplus Object Service for creating a hyperlink or to deal with the group of hyperlinks belonging to an object, issue or slide.

Get details of the hyperlink

Resource: hyperlink/<hyperlink_id>

URL: https://api-stage.bimplus.net/v2/<team_slug>/hyperlinks/<hyperlink_id>

Example:https://api-stage.bimplus.net/v2/bimplus/hyperlinks/db540336-47a3-426e-b3bf-1e532bfac8ea

GET

Get details of a specified hyperlink.

Headers

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

Status

Status: 200 OK

JSON

{
    "orderNumber": 1,
    "name": "My website",
    "url": "https://www.bimplus.net/",
    "id": "c46d1080-0450-4f03-aa4d-a32300e018e9"
}

Update the hyperlink

Resource: hyperlink/<hyperlink_id>

URL: https://api-stage.bimplus.net/v2/<team_slug>/hyperlinks/<hyperlink_id>

Example:https://api-stage.bimplus.net/v2/bimplus/hyperlinks/db540336-47a3-426e-b3bf-1e532bfac8ea

JSON Structure:

Name	Mandatory / Optional	Type	Description
orderNumber	optional	integer	The ordering number of the hyperlink
name	optional	string	Name of the hyperlink
url	optional	string	The actual url
id	will be ignored	string (guid)	Id of the hyperlink

PUT

Update the specified hyperlink.

Headers

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

JSON

{    
    "name": "My new website",
    "url": "https://www-stage.bimplus.net/"
}

Status

Status: 200 OK

Delete the hyperlink

Resource: hyperlink/<hyperlink_id>

URL: https://api-stage.bimplus.net/v2/<team_slug>/hyperlinks/<hyperlink_id>

Example:https://api-stage.bimplus.net/v2/bimplus/hyperlinks/db540336-47a3-426e-b3bf-1e532bfac8ea

DELETE

Deletes a specified hyperlink.

Headers

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

Status

Status: 200 OK

Structure Service

A hierarchical tree structure(eg: cost structure) could be added and later retrieved from a project/object using the Structure service

Create a new structure in a project

Resource: projects/<project_id>/structures

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

Example:https://api-stage.bimplus.net/v2/bimplus/projects/622272da-f1ff-45ab-a3f0-c8f1255c80e8/structures

JSON Structure:

Name	Mandatory / Optional	Type	Description
parentId	mandatory	string(guid)	Parent node id of the structure (for the first structure, projectId is the parentId)
name	mandatory	string	Name of the structure
description	optional	string	Description of the structure
type	optional	string	Type of the structure (eg: costStructure, specificationStructure)
nr	will be ignored	integer	The index of the structure
color	optional	integer	Color of the structure
id	will be ignored	string(guid)	Unique guid of the structure

POST

Create a new structure(eg: cost structure, specification structure) under a project

Headers

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

JSON

{
    "name": "TestStructure",
    "description": "FullLifeCycleTest",
    "type": "CostStructure"
}

Status

Status: 201 Created

JSON

{
    "parentId": "622272da-f1ff-45ab-a3f0-c8f1255c80e8",
    "name": "TestStructure",
    "description": "FullLifeCycleTest",
    "type": "CostStructure",
    "nr": 1,
    "color": 0,
    "id": "179439d6-df16-41cc-bd2c-74d05b7995d5"
}

Get the structure details

Resource: structures/<structure_id>

URL: https://api-stage.bimplus.net/v2/<team_slug>/structures/<structure_id>

Example:https://api-stage.bimplus.net/v2/bimplus/structures/179439d6-df16-41cc-bd2c-74d05b7995d5

GET

Get details of a specified structure.

Headers

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

Status

Status: 200 OK

JSON

{
    "name": "TestStructure",
    "description": "FullLifeCycleTest",
    "type": "CostStructure",
    "nr": 1,
    "color": 0,
    "id": "179439d6-df16-41cc-bd2c-74d05b7995d5"
}

Create a sub-node under the structure

Resource: structures/<structure_id>

URL: https://api-stage.bimplus.net/v2/<team_slug>/structures/<structure_id>

Example:https://api-stage.bimplus.net/v2/bimplus/structures/179439d6-df16-41cc-bd2c-74d05b7995d5

JSON Structure:

Name	Mandatory / Optional	Type	Description
parentId	mandatory	string(guid)	Parent node id of the structure (the id specified in the resource url)
name	mandatory	string	Name of the structure
description	optional	string	Description of the structure
type	optional	string	Type of the structure (eg: costStructure, specificationStructure)
nr	will be ignored	integer	The index of the structure
color	optional	integer	Color of the structure
id	will be ignored	string(guid)	Unique guid of the structure

POST

Create a sub-node under a particular structure

Headers

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

JSON

{
  "name": "Node 1"
}

Status

Status: 201 Created

JSON

{
    "parentId": "179439d6-df16-41cc-bd2c-74d05b7995d5",
    "name": "Node 1",
    "type": "TopologyStructure",
    "nr": 1,
    "color": 0,
    "id": "adf506ae-3628-4501-9af1-22bcf27e4ab4"
}

Get the structure topology

Resource: structures/<structure_id>/topology

URL: https://api-stage.bimplus.net/v2/<team_slug>/structures/<structure_id>/topology

Example:https://api-stage.bimplus.net/v2/bimplus/structures/179439d6-df16-41cc-bd2c-74d05b7995d5/topology

GET

Get details of a specified structure.

Headers

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

Status

Status: 200 OK

JSON

{
    "parent": null,
    "name": "TestStructure",
    "type": "Structure",
    "children": [
        {
            "parent": "179439d6-df16-41cc-bd2c-74d05b7995d5",
            "name": "Node 1",
            "type": "Structure",
            "children": [],
            "id": "adf506ae-3628-4501-9af1-22bcf27e4ab4"
        }
    ],
    "id": "179439d6-df16-41cc-bd2c-74d05b7995d5"
}

Assign an object to the latest/last structure node

Resource: structures/<structure_id>/assign/<object_id>

URL: https://api-stage.bimplus.net/v2/<team_slug>/structures/<structure_id>/assign/<object_id>

Example:https://api-stage.bimplus.net/v2/bimplus/structures/179439d6-df16-41cc-bd2c-74d05b7995d5/assign/df4a81d6-42fb-4187-bbce-82a2fc093b2f

JSON Structure:

Name	Mandatory / Optional	Type	Description
structureId	will be ignored	string(guid)	The id of the last node to which an object will be assigned
objectId	will be ignored	string(guid)	The id of the object to whom a structure will be assigned
name	mandatory	string	The name of the structure-object connection
nr	will be ignored	integer	The index of the structure-object connection
id	will be ignored	string(guid)	Unique guid of the structure-object connection

POST

Assign an object to the latest/last structure node

Headers

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

JSON

{
  "name": "WallConnection"
}

Status

Status: 201 Created

JSON

{
    "structureId": "adf506ae-3628-4501-9af1-22bcf27e4ab4",
    "objectId": "df4a81d6-42fb-4187-bbce-82a2fc093b2f",
    "name": "WallConnection",
    "nr": 1,
    "id": "35b986c2-e9cd-482e-9281-6000671a49f0"
}

Update the structure

Resource: structures/<structure_id>

URL: https://api-stage.bimplus.net/v2/<team_slug>/structures/<structure_id>

Example:https://api-stage.bimplus.net/v2/bimplus/structures/179439d6-df16-41cc-bd2c-74d05b7995d5

JSON Structure:

Name	Mandatory / Optional	Type	Description
parentId	optional	string(guid)	Parent node id of the structure (for the first structure, projectId is the parentId)
name	optional	string	Name of the structure
description	optional	string	Description of the structure
type	optional	string	Type of the structure (eg: costStructure, specificationStructure)
nr	optional	integer	The index of the structure
color	optional	integer	Color of the structure
id	will be ignored	string(guid)	Unique guid of the structure

PUT

Update the specified structure

Headers

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

JSON

{
  "name": "Updated Structure"
}

Status

Status: 200 OK

JSON

{
    "parentId": "622272da-f1ff-45ab-a3f0-c8f1255c80e8",
    "name": "Updated Structure",
    "description": "FullLifeCycleTest",
    "type": "CostStructure",
    "nr": 1,
    "color": 0,
    "id": "179439d6-df16-41cc-bd2c-74d05b7995d5"
}

Delete the structure

Resource: structures/<structure_id>

URL: https://api-stage.bimplus.net/v2/<team_slug>/structures/<structure_id>

Example:https://api-stage.bimplus.net/v2/bimplus/structures/db540336-47a3-426e-b3bf-1e532bfac8ea

DELETE

Deletes a specified structure.

Headers

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

Status

Status: 200 OK

Clash Service

Clashes could be detected in a project by calling this service. The person who uploaded the model which contains the clash will get a notification along with the clash count after the clash process is completed. This process will be called during model import in the future.

Detect the clashes in a project

Resource: services/postprocess

URL: https://api-stage.bimplus.net/v2/<team_slug>/services/postprocess

Example:https://api-stage.bimplus.net/v2/bimplus/services/postprocess

JSON Structure:

Name	Mandatory / Optional	Type	Description
runAsync	mandatory	bool	True sets the clash process to run asynchronously
postProcess	mandatory	object	It runs as a windows service in the server
projectId	mandatory	string	Id of the project

POST

Detects the clashes in a project. This process will be called during model import automatically in the future. The person who uploaded the model which contains the clash will get a notification along with the clash count after the clash process is completed.

Headers

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

JSON

{
    "runAsync": "True",
    "postProcess": {
        "projectId": "0c9b514a-5b30-4f77-b0ff-2184d079fd30"
    }
}

Status

Status: 200 Ok

JSON

{
    "postProcess": {
        "projectId": "0c9b514a-5b30-4f77-b0ff-2184d079fd30"
    },
    "runAsync": false
}

Authorization Service

Authorizes a user and returns a token for further API calls

Resource: authorize

URL: https://api-stage.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

POST

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

Headers

Content-Type: application/json

JSON

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

Status

Status: 200 OK

JSON

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

Get token information

Resource: authorize

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

GET

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

Headers

Content-Type: application/json

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088

Status

Status: 200 OK

JSON

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

}

where,

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

Request a cross token

Resource: cross-token

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

POST

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.

Headers

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

Status

Status: 200 OK

JSON

{
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

Resource: cross-authorize

URL: https://api-stage.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

POST

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.

Headers

Content-Type: application/json

JSON

{
"cross_token": "b392cee4d0044ef681fa911772668cf9"
}

Status

Status: 200 OK

JSON

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

Revoke / Expire the token

Resource: authorize

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

DELETE

The specified token will expire immediately.

Headers

Content-Type: application/json

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088

Status

Status: 200 OK

User Management Service

Please remember that creating/updating/deleting an user is possible only for the clients who has the permission to do it.

Create a new user

Resource: users

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

Example: https://api-stage.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
firstname	optional	string	First name of the user
lastname	optional	string	Last name of the user
company	optional	string	Company of the user
displayname	optional	string	Display name of the user
info	optional	string	Information of the user
gender	optional	string	Gender of the user
phoneWork	optional	string	Office phone number of the user
phoneHome	optional	string	Home phone number of the user
fax	optional	string	Fax number of the user
mobile	optional	string	Mobile number of the user
birthDate	optional	string	Birth date of the user
address	optional	object	Address of the user
street	optional	string	Street name of the user
streetNr	optional	string	Street number of the user
zip	optional	string	Zip code
city	optional	string	City name of the user
country	optional	string	Country name of the user
preferredLanguage	optional	string	Preferred language of the user (will be set in the portal)
teams	will be ignored	array	Team list of the user
team	will be ignored	object	Information about an user's team (See the team service)
projects	will be ignored	array	Project list of the user
project	will be ignored	object	Information about an user's project (See the project service)

POST

Creates a new user account. Please remember that this service can be used only by the shop/portal (secured using the application_id of portal)

Headers

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

JSON

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

Status

Status: 201 Created

JSON

{
    "projects": [],
    "teams": [],
    "id": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6",
    "email": "test@bimplus.net",
    "status": "Active",
    "firstname": "",
    "lastname": "",
    "company": "",
    "displayname": "",
    "info": "",
    "gender": "",
    "phoneWork": "",
    "phoneHome": "",
    "fax": "",
    "mobile": "",
    "birthDate": "",
    "address": {
        "street": "",
        "streetNr": "",
        "zip": "",
        "city": "",
        "country": ""
    },
    "preferedLanguage": ""
}

Get information about the user

Resource: users/<user_id>

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

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

GET

Get information about a specified user.

Headers

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

Status

Status: 200 OK

JSON

{
    "projects": [],
    "teams": [],
    "id": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6",
    "email": "test@bimplus.net",
    "status": "Active",
    "firstname": "",
    "lastname": "",
    "company": "",
    "displayname": "",
    "info": "",
    "gender": "",
    "phoneWork": "",
    "phoneHome": "",
    "fax": "",
    "mobile": "",
    "birthDate": "",
    "address": {
        "street": "",
        "streetNr": "",
        "zip": "",
        "city": "",
        "country": ""
    },
    "preferedLanguage": ""
}

Update information about the user

Resource: users/<user_id>

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

Example: https://api-stage.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
firstname	optional	string	First name of the user
lastname	optional	string	Last name of the user
company	optional	string	Company of the user
displayname	optional	string	Display name of the user
info	optional	string	Information of the user
gender	optional	string	Gender of the user
phoneWork	optional	string	Office phone number of the user
phoneHome	optional	string	Home phone number of the user
fax	optional	string	Fax number of the user
mobile	optional	string	Mobile number of the user
birthDate	optional	string	Birth date of the user
address	optional	object	Address of the user
street	optional	string	Street name of the user
streetNr	optional	string	Street number of the user
zip	optional	string	Zip code
city	optional	string	City name of the user
country	optional	string	Country name of the user
preferredLanguage	optional	string	Preferred language of the user (will be set in the portal)
teams	will be ignored	array	Team list of the user
team	will be ignored	object	Information about an user's team (See the team service)
projects	will be ignored	array	Project list of the user
project	will be ignored	object	Information about an user's project (See the project service)

PUT

Update information about a specified user. Please remember that this service can be used only by the shop/portal (secured using the application_id of portal)

Headers

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

JSON

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

Status

Status: 200 OK

Delete the user

Resource: users

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

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

DELETE

Delete a specified user. Please remember that this service can be used only by the shop/portal (secured using the application_id of portal)

Headers

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

Status

Status: 200 OK

Get information about the currently logged in user

Resource: user

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

GET

Get information about the currently logged in user.

Headers

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

Status

Status: 200 OK

JSON

{
    "projects": [],
    "teams": [],
    "id": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6",
    "email": "test@bimplus.net",
    "status": "Active",
    "firstname": "",
    "lastname": "",
    "company": "",
    "displayname": "",
    "info": "",
    "gender": "",
    "phoneWork": "",
    "phoneHome": "",
    "fax": "",
    "mobile": "",
    "birthDate": "",
    "address": {
        "street": "",
        "streetNr": "",
        "zip": "",
        "city": "",
        "country": ""
    },
    "preferedLanguage": ""
}

Team Management Service

Please remember that creating/updating/deleting a team is possible only for the clients who has the permission to do it.

Create a new team and its related database

Resource: teams

URL: https://api-stage.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
displayname	mandatory	string	The name of the team which will be displayed in the client
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 (usedSpace, numberOfProjects, numberOfMembers, totalSpace, totalNumberOfProjects, totalNumberOfMembers)
status	will be ignored	string	Active / Inactive
teamWorksConnection	optional	string	Base64 encoded database connection string for legacy applications
dataStorageStatus	optional	string	Online / Offline
haswriteaccess	will be ignored	boolean	Write access to the team
public	optional	object	Public read/write rights
read	optional	boolean	Read right (viewer right to all the projects under this team to all the registered users)
write	optional	boolean	Write right (write right to all the projects under this team to all the registered users)
rights	object	object	Project rights
projectCreate	will be ignored	boolean	The client can use this information to check whether a user can create a project for this team (See the Rights & Roles to learn more about it)

POST

Create a new team and its related database. Please remember that this service can be used only by the shop/portal (secured using the application_id of portal)

Headers

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

JSON

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

Status

Status: 201 Created

JSON

{
    "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",
    "haswriteaccess": false,
    "public": {
        "read": false,
        "write": false
    },
    "rights": {
        "projectCreate": true
    }  
}

Get information about the team

Resource: teams/<team_slug>

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

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

GET

Get information about a specified team.

Headers

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

Status

Status: 200 OK

JSON

{
    "id": "db038754-2598-4616-9ea2-2c0947f2e93a",
    "slug": "best-company",
    "name": "Best Company",
    "displayname": "Best Company (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",
    "public": {
        "read": false,
        "write": false
    },
    "rights": {
        "projectCreate": true
    }  
}

Update information about the team

Resource: teams/<team_slug>

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

Example: https://api-stage.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 (usedSpace, numberOfProjects, numberOfMembers, totalSpace, totalNumberOfProjects, totalNumberOfMembers)
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
haswriteaccess	will be ignored	boolean	Write access to the team
public	optional	object	Public read/write rights
read	optional	boolean	Read right (viewer right to all the projects under this team to all the registered users)
write	optional	boolean	Write right (write right to all the projects under this team to all the registered users)
rights	object	object	Project rights
projectCreate	will be ignored	boolean	The client can use this information to check whether a user can create a project for this team (See the Rights & Roles to learn more about it)

PUT

Update information about a specified team. Please remember that this service can be used only by the shop/portal (secured using the application_id of portal)

Headers

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

JSON

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

Status

Status: 200 OK

Delete the team

Resource: teams/<team_slug>

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

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

DELETE

Delete a specified team. Please remember that this service can be used only by the shop/portal (secured using the application_id of portal)

Headers

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

Status

Status: 200 OK

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

Resource: teams

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

GET

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

Headers

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

Status

Status: 200 OK

JSON

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

Membership Management Service

Please remember that the team owner cannot remove the membership from his own team.

Add the user to the team

Resource: <team_slug>/members

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

Example: https://api-stage.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
member_status	optional	string	Status of the membership(Active / Passive)

POST

Add a specified user to a specified team.

Headers

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

JSON

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

}

Status

Status: 200 Ok

Get the member list of the team

Resource: <team_slug>/members

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

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

GET

Gets the member list of a specified team.

Headers

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

Status

Status: 200 OK

JSON

[
    {
        "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

Resource: <team_slug>/members/<user_id>

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

Example: https://api-stage.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)

PUT

Update information about a specified user in a team.

Headers

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

JSON

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

Status

Status: 200 OK

Delete the user from the team

Resource: <team_slug>/members/<user_id>

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

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

DELETE

Deletes a specified user from a team.

Headers

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

Status

Status: 200 OK

Rights & Roles Service

Get all the available roles

Resource: <team_slug>/roles

URL: https://api-stage.bimplus.net/v2/<team_slug>/roles

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

GET

Get all the available. Right now, we support only project based roles.

Here is the definition of Bimplus Rights & Roles.

	Account Owner	Project Admin	Project Editor	Project Viewer	Model Admin	Model Editor	Model Viewer
Create Project	x	x
Admin Project (eg. invite)	x	x
Edit Project	x	x	x
Delete Project	x	x
View Project	x	x	x	x	x	x	x

View all Models	x	x	x	x
Create Model	x	x	x
Admin Model (eg. invite)	x	x
Assign User to Model	x	x	x		x
Edit Model	x	x	x		x	x
Import Data	x	x	x		x	x
Delete Model	x	x	x		x
View Model	x	x	x	x	x	x	x

Headers

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

Status

Status: 200 Ok

JSON

[
    {
        "id": "f11d32e2-30b7-4f81-8a74-2165ecc00cf6",
        "name": "Project_Editor",
        "customRole": false,
        "resources": [
            {
                "resource": "UserRightProject",
                "rights": [
                    "Project_Edit",
                    "Project_View",
                    "Model_ViewAll"
                ]
            }
        ]
    },
    {
        "id": "2baca0e4-2eee-4f7c-bc56-22ed54a1859c",
        "name": "Account_Owner",
        "customRole": false,
        "resources": [
            {
                "resource": "UserRightGlobal",
                "rights": [
                    "AllProjects",
                    "AllModels",
                    "Project_Create"
                ]
            }
        ]
    },
    {
        "id": "a298b28d-9711-4a76-9a7d-910cbf144ee5",
        "name": "Project_Admin",
        "customRole": false,
        "resources": [
            {
                "resource": "UserRightProject",
                "rights": [
                    "Project_Admin",
                    "Project_Edit",
                    "Project_Delete",
                    "Project_View",
                    "Model_ViewAll",
                    "Model_Create"
                ]
            }
        ]
    },
    {
        "id": "a618d075-7e4a-4bde-9d58-d2979696fa96",
        "name": "Project_Viewer",
        "customRole": false,
        "resources": [
            {
                "resource": "UserRightProject",
                "rights": [
                    "Project_View",
                    "Model_ViewAll"
                ]
            }
        ]
    }
]

Make a team member part of a project by assigning a role to him

Resource: projects/<project_id>/members

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

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

JSON Structure:

Name	Mandatory / Optional	Type	Description
member	mandatory	object	The member who will be assigned a role to the project
id	mandatory	string (guid)	Id of the user
role	mandatory	object	The project role which will be assigned to the team member
id	mandatory	string (guid)	Id of the role

POST

Assign a project role to an existing member of a team. Only the user with "Account Owner" or "Project Owner" role can use this API call.

Headers

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

JSON

{
  "member": {
    "id": "bf5b2382-1d14-b8df-8454-947f83b45c25"
  },
  role: {
    id: "f11d32e2-30b7-4f81-8a74-2165ecc00cf6"
}

Status

Status: 201 Created

JSON

{
  "member": {
    "id": "bf5b2382-1d14-b8df-8454-947f83b45c25",
    "email": "customer@bimplus.net"
  },
  "role": {
    "id": "f11d32e2-30b7-4f81-8a74-2165ecc00cf6",
    "name": "Project_Editor"
}

Get the project members along with their respective roles

Resource: projects/<project_id>/members

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

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

GET

Get the member list of a project along with their respective project roles.

Headers

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

Status

Status: 200 OK

JSON

[
    {
        "member": {
            "id": "7aa846f2-6014-f68d-8dd4-4c7941d7cbcc",
            "email": "customer1@bimplus.net"
        },
        "role": {
            "id": "f11d32e2-30b7-4f81-8a74-2165ecc00cf6",
            "name": "Project_Editor"
        }
    },
    {
        "member": {
            "id": "bf5b2382-1d14-b8df-8454-947f83b45c25",
            "email": "customer2@bimplus.net"
        },
        "role": {
            "id": "e11d32e2-30b7-4f81-8a74-2165ecc00cf6",
            "name": "Project_Viewer"
        }
    }
]

Update the project role of a team member

Resource: projects/<project_id>/members

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

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

JSON Structure:

Name	Mandatory / Optional	Type	Description
member	mandatory	object	The member who will be assigned a role to the project
id	mandatory	string (guid)	Id of the user
role	mandatory	object	The project role which will be assigned to the team member
id	mandatory	string (guid)	Id of the role

PUT

Update the project role of a team member. Only the user with "Account Owner" or "Project Owner" role can use this API call.

Headers

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

JSON

{
  "member": {
    "id": "bf5b2382-1d14-b8df-8454-947f83b45c25",
    "email": "customer@bimplus.net"
  },
  "role": {
    "id": "f11d32e2-30b7-4f81-8a74-2165ecc00cf6",
    "name": "Project_Viewer"
}

Status

Status: 200 OK

Remove the user from the project

Resource: projects/<project_id>/members

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

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

DELETE

Remove the user from a project

Headers

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

Status

Status: 200 OK

Messaging Service

Create a new message for an user

Resource: messages

URL: https://api-stage.bimplus.net/v2/messages

Example: https://api-stage.bimplus.net/v2/messages

JSON Structure:

Name	Mandatory / Optional	Type	Description
id	will be ignored	string	Id of the message
receiver	mandatory	object	receiver user object (contains id & email)
sender	optional	object	sender user object (contains id & email)
id	mandatory	string(guid)	id of the user
email	mandatory	string	email id of the user
source	mandatory	string	Source of the message (eg: Import Service)
topic	mandatory	string	Topic of the message
severity	mandatory	object	Severity can be Info, Warning, Error
returnCode	mandatory	string	Readable return code
timestamp	will be ignored	string	Creation date of the message
unread	mandatory	boolean	Whether the message was unread
additionalData	optional	string	Extra info
correlationId	optional	guid	Id of the other related message

POST

Create a new message for an user.

Headers

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

JSON

{
    "id": "4633d522-53aa-4d81-90b4-704681e0573d",
    "sender": {
            "id": "1110ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer1@bimplus.net"
    },
    "receiver": {
            "id": "1e2223b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer2@bimplus.net"
    },
    "source": "ServiceName",
    "topic": "SKETCHUP_JOB",
    "severity": "Warn",
    "returncode": "FILE_TOO_BIG",
    "unread": false,
    "timestamp": "2013-11-15T10:55:53"
}

Status

Status: 201 Created

Get the message list of the current user

Resource: user/<user_id>/messages

URL: https://api-stage.bimplus.net/v2/user/<user_id>/messages

Example: https://api-stage.bimplus.net/v2/user/123456789/messages

GET

Gets the message list of the current user

Headers

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

Status

Status: 200 OK

JSON

[
    {
        "id": "481713d6-7dab-410c-8c8a-d65ff1d4a766",
        "sender": {
            "id": "1110ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer1@bimplus.net"
        },
        "receiver": {
            "id": "1e2223b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer2@bimplus.net"
        },
        "source": "ServiceName2",
        "topic": "SKETCHUP_JOB",
        "severity": "Info",
        "returncode": "FILE_TOO_BIG",
        "timestamp": "2013-11-18T14:55:22",
        "unread": false,
        "additionaldata": null,
        "correlationid": null
    },
    {
        "id": "93c29c5d-1391-4ae8-8876-ef9815e60f7d",
        "sender": {
            "id": "1110ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer1@bimplus.net"
        },
        "receiver": {
            "id": "1e2223b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer2@bimplus.net"
        },
        "source": "ServiceName",
        "topic": "IFC_JOB",
        "severity": "Info",
        "returncode": "OK",
        "timestamp": "2013-11-18T14:30:53",
        "unread": true,
        "additionaldata": null,
        "correlationid": null
    }
]

Get the message list of all the users

Resource: messages

URL: https://api-stage.bimplus.net/v2/user/messages

Example: https://api-stage.bimplus.net/v2/messages

GET

Gets the message list of the current user

Headers

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

Status

Status: 200 OK

JSON

[
    {
        "id": "481713d6-7dab-410c-8c8a-d65ff1d4a766",
        "sender": {
            "id": "1110ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer1@bimplus.net"
        },
        "receiver": {
            "id": "1e2223b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer2@bimplus.net"
        },
        "source": "ServiceName2",
        "topic": "SKETCHUP_JOB",
        "severity": "Info",
        "returncode": "FILE_TOO_BIG",
        "timestamp": "2013-11-18T14:55:22",
        "unread": false,
        "additionaldata": null,
        "correlationid": null
    },
    {
        "id": "93c29c5d-1391-4ae8-8876-ef9815e60f7d",
        "sender": {
            "id": "1110ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer1@bimplus.net"
        },
        "receiver": {
            "id": "1e2223b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer3@bimplus.net"
        },
        "source": "ServiceName",
        "topic": "IFC_JOB",
        "severity": "Info",
        "returncode": "OK",
        "timestamp": "2013-11-18T14:30:53",
        "unread": true,
        "additionaldata": null,
        "correlationid": null
    }
]

Get information about a specified message

Resource: messages

URL: https://api-stage.bimplus.net/v2/messages/<message_id>

Example: https://api-stage.bimplus.net/v2/messages/<message_id>

GET

Get information about a specified message

Headers

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

Status

Status: 200 OK

JSON

{
    "id": "93c29c5d-1391-4ae8-8876-ef9815e60f7d",
    "sender": {
            "id": "1110ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer1@bimplus.net"
    },
    "receiver": {
            "id": "1e2223b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer2@bimplus.net"
    },
    "source": "ServiceName",
    "topic": "IFC_JOB",
    "severity": "Info",
    "returncode": "OK",
    "timestamp": "2013-11-18T14:30:53",
    "unread": true,
    "additionaldata": null,
    "correlationid": null
}

Delete the specified message

Resource: messages/<message_id>

URL: https://api-stage.bimplus.net/v2/messages/<message_id>

Example: https://api-stage.bimplus.net/v2/messages/<message_id>

DELETE

Delete the specified message.

Headers

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

Status

Status: 200 OK

Mark a message as "read"

Resource: messages/<message_id>/markasread

URL: https://api-stage.bimplus.net/v2/messages/<message_id>/markasread

Example: https://api-stage.bimplus.net/v2/messages/<message_id>/markasread

POST

Mark a message as read.

Headers

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

Status

Status: 200 OK

Filter the messages (eg: Get all the unread messages from a particular user)

Resource: messages?filter=<property><operator><value>%26<property><operator><value>%26....

URL: https://api-stage.bimplus.net/v2/messages?filter=unread=true%26receiver.email=customer@bimplus.net%26source=IssueService

Example: https://api-stage.bimplus.net/v2/messages?filter=unread=true%26receiver.email=customer@bimplus.net%26source=IssueService

where "%26" is the escape character for "&"

GET

Get information about a specified message

Headers

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

Status

Status: 200 OK

JSON

[
    {
        "id": "44ad058b-1f76-4343-bafa-031eb462215c",
        "receiver": {
            "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer@bimplus.net"
        },
        "sender": {
            "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "testuser1@bimplus.net"
        },
        "source": "IssueService",
        "topic": "ISSUE_DELETED",
        "severity": "Info",
        "returnCode": "ISSUE_DELETED",
        "timestamp": "2014-05-09T09:54:17",
        "unread": true,
        "correlationId": null
    },
    {
        "id": "0a4c8eab-26af-49ce-9191-049a141ba762",
        "receiver": {
            "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer@bimplus.net"
        },
        "sender": {
            "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "testuser1@bimplus.net"
        },
        "source": "IssueService",
        "topic": "ISSUE_UPDATED",
        "severity": "Info",
        "returnCode": "ISSUE_UPDATED",
        "timestamp": "2014-04-08T08:54:41",
        "unread": true,
        "correlationId": "de96f4ae-79fd-4d83-99e9-07cec7a80906"
    },
    {
        "id": "ffd50096-fb82-4029-8d49-06a04e31f02a",
        "receiver": {
            "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer@bimplus.net"
        },
        "sender": {
            "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "testuser2@bimplus.net"
        },
        "source": "IssueService",
        "topic": "ISSUE_DELETED",
        "severity": "Info",
        "returnCode": "ISSUE_DELETED",
        "timestamp": "2014-05-09T09:54:27",
        "unread": true,       
        "correlationId": null
    }
]

Log Service

Get all the log data

Resource: logs

URL: https://api-stage.bimplus.net/v2/logs

Example: https://api-stage.bimplus.net/v2/logs

GET

Retrieves the whole log information from the beginning of the time.

It is always better to use the other log API call which retrieves the log info between the time interval as this API will cause serious bandwidth usage

Headers

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

Status

Status: 200 OK

JSON

[
     {
        "id": 853539,
        "server": "K2177",
        "date": "2013-12-16T10:00:23",
        "requestid": "653750b3-a97e-451f-bd01-1a4671344087",
        "thread": "51",
        "level": "INFO",
        "logger": "PerformanceLog.ServiceLog",
        "message": "BEGIN Request (GET /v2/best-company/projects/679532b9-f7f7-41ce-817f-6e58225b32b1/disciplines)",
        "exception": "", 
        "userid": "123456789",
        "clientid":"987654321",
        "executiontime": "1234"
    },
    {
        "id": 853540,
        "server": "K2177",
        "date": "2013-12-16T10:00:23",
        "requestid": "653750b3-a97e-451f-bd01-1a4671344087",
        "thread": "51",
        "level": "INFO",
        "logger": "PerformanceLog.UserLog",
        "message": "User found byId: bestcustomer@bimplus.net",
        "exception": "",
        "userid": "123456789",
        "clientid":"987654321",
        "executiontime": "1234"
    },
    {
        "id": 853541,
        "server": "K2177",
        "date": "2013-12-16T10:00:23",
        "requestid": "653750b3-a97e-451f-bd01-1a4671344087",
        "thread": "51",
        "level": "INFO",
        "logger": "PerformanceLog.ServiceLog",
        "message": "END Request (GET /v2/best-company/projects/679532b9-f7f7-41ce-817f-6e58225b32b1/disciplines) with StatusCode 200; took 216 ms",
        "exception": "",
        "userid": "123456789",
        "clientid":"987654321",
        "executiontime": "1234"
    },.....]

Get the log data between the time interval

Resource: logs

URL: https://api-stage.bimplus.net/v2/logs/<startDate>/<endDate>

Example: https://api-stage.bimplus.net/v2/logs/20130101/20130102

OR

https://api-stage.bimplus.net/v2/logs/201301011200/201301011400

GET

Retrieves the log information between the mentioned time interval. The time interval could be either date based(eg: between 01.01.2013,02.01.2013) or time based (between 01.01.2013 12:00, 01.01.2013 14:00)

Headers

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

Status

Status: 200 OK

JSON

[
     {
        "id": 853539,
        "server": "K2177",
        "date": "2013-12-16T10:00:23",
        "requestid": "653750b3-a97e-451f-bd01-1a4671344087",
        "thread": "51",
        "level": "INFO",
        "logger": "PerformanceLog.ServiceLog",
        "message": "BEGIN Request (GET /v2/best-company/projects/679532b9-f7f7-41ce-817f-6e58225b32b1/disciplines)",
        "exception": "",
        "userid": "123456789",
        "clientid":"987654321",
        "executiontime": "1234"
    },
    {
        "id": 853540,
        "server": "K2177",
        "date": "2013-12-16T10:00:23",
        "requestid": "653750b3-a97e-451f-bd01-1a4671344087",
        "thread": "51",
        "level": "INFO",
        "logger": "PerformanceLog.UserLog",
        "message": "User found byId: bestcustomer@bimplus.net",
        "exception": "",
        "userid": "123456789",
        "clientid":"987654321",
        "executiontime": "1234"
    },
    {
        "id": 853541,
        "server": "K2177",
        "date": "2013-12-16T10:00:23",
        "requestid": "653750b3-a97e-451f-bd01-1a4671344087",
        "thread": "51",
        "level": "INFO",
        "logger": "PerformanceLog.ServiceLog",
        "message": "END Request (GET /v2/best-company/projects/679532b9-f7f7-41ce-817f-6e58225b32b1/disciplines) with StatusCode 200; took 216 ms",
        "exception": "",
        "userid": "123456789",
        "clientid":"987654321",
        "executiontime": "1234"
    },.....]

Bimplus Windows Explorer related Services

Bimplus Windows Explorer is the Windows desktop application AEC professionals and BIM managers use to upload, manage and analyze building information on the Bimplus platform for use by all contributors to your construction project. For more information please see here

Create a new objectview

Resource: objectlist

URL: https://api-stage.bimplus.net/v2/<team_slug>objectlist

Example: https://api-stage.bimplus.net/v2/bimplus/objectlist

JSON Structure:

Name	Mandatory / Optional	Type	Description
elementsId	mandatory	object	List of elements id
columnsList	mandatory	object	List of columns
tableName	mandatory	string	Name of the resource
columnName	optional	string	Name of the property
freeAttribId	optional	string(guid)	Id of the used free attribute

POST

Create a new objectview

Headers

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

JSON

{
    "elementsId": [
        "8506156B-F965-4D51-9DD1-01D0C300601E",
        "CF9E6219-2962-4F21-B1DD-01DC4AB902E9",
        "1A8BF9BF-C912-4E2C-A633-F9BDEF46EB91"
    ],
    "columnsList": [
        {
            "tableName": "general",
            "columnName": "Name",
            "freeAttribId": null
        },
        {
            "tableName": "general",
            "columnName": "Description",
            "freeAttribId": null
        },
        {
            "tableName": "quantity",
            "columnName": "Length",
            "freeAttribId": null
        },
        {
            "tableName": "quantity",
            "columnName": "Height",
            "freeAttribId": null
        },
        {
            "tableName": "element",
            "columnName": "ElementTyp",
            "freeAttribId": null
        },
        {
            "tableName": "element",
            "columnName": "DivisionID",
            "freeAttribId": null
        },
        {
            "tableName": "stringattrib",
            "columnName": "",
            "freeAttribId": "C3071F78-2ACA-46D9-9883-13F5184EC499"
        },
        {
            "tableName": "doubleattrib",
            "columnName": "",
            "freeAttribId": "8D3D9DD5-C998-465B-B13E-87901C90F3BC"
        }
    ]
}

Status

Status: 201 CREATED

JSON

{
    "elementsId": [
        "8506156B-F965-4D51-9DD1-01D0C300601E",
        "CF9E6219-2962-4F21-B1DD-01DC4AB902E9",
        "1A8BF9BF-C912-4E2C-A633-F9BDEF46EB91"
    ],
    "columnsList": [
        {
            "tableName": "general",
            "columnName": "Name",
            "freeAttribId": null
        },
        {
            "tableName": "general",
            "columnName": "Description",
            "freeAttribId": null
        },
        {
            "tableName": "quantity",
            "columnName": "Length",
            "freeAttribId": null
        },
        {
            "tableName": "quantity",
            "columnName": "Height",
            "freeAttribId": null
        },
        {
            "tableName": "element",
            "columnName": "ElementTyp",
            "freeAttribId": null
        },
        {
            "tableName": "element",
            "columnName": "DivisionID",
            "freeAttribId": null
        },
        {
            "tableName": "stringattrib",
            "columnName": "",
            "freeAttribId": "C3071F78-2ACA-46D9-9883-13F5184EC499"
        },
        {
            "tableName": "doubleattrib",
            "columnName": "",
            "freeAttribId": "8D3D9DD5-C998-465B-B13E-87901C90F3BC"
        }
    ]
}

Get the list of target objects(objectviews) which will be populated in the "Object Navigator List"

Resource: objectview

URL: https://api-stage.bimplus.net/v2/<team_slug>/objectviews

Example: https://api-stage.bimplus.net/v2/bimplus/objectviews

GET

Get the list of target objectviews which will be populated in the "Object Navigator List"

Headers

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

Status

Status: 200 OK

JSON

[
    {
        "viewname": "onProjectElements_Building",
        "resourcenameid": "Category.ElementBuilding",
        "iconid": "IconArchitectureWall",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element",
        "ordernr": 21
    },
    {
        "viewname": "onProjectElements_Room",
        "resourcenameid": "Category.ElementRoom",
        "iconid": "IconArchitectureRoom",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element",
        "ordernr": 22
    },
    {
        "viewname": "onProjectElements_Finish",
        "resourcenameid": "Category.ElementFinish",
        "iconid": "IconRoofLayer",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element",
        "ordernr": 23
    },
    {
        "viewname": "onProjectElements_Reinforcement",
        "resourcenameid": "Category.Reinforcement",
        "iconid": "IconReinforcement",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element",
        "ordernr": 24
    },
    {
        "viewname": "onProjectElements_Mesh",
        "resourcenameid": "Category.Mesh",
        "iconid": "IconMesh",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element",
        "ordernr": 25
    },
    {
        "viewname": "onProjectElements_Precast",
        "resourcenameid": "Category.PrecastElement",
        "iconid": "IconPrecastUnit",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element",
        "ordernr": 27
    },
    {
        "viewname": "onProjectElements_PrecastTimber",
        "resourcenameid": "Category.ElementPrecastTimber",
        "iconid": "IconFolder",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element",
        "ordernr": 28
    },
    {
        "viewname": "onProjectElements_MEP",
        "resourcenameid": "Category.ElementMEP",
        "iconid": "IconFolder",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element",
        "ordernr": 29
    },
    {
        "viewname": "onProjectElements_Plumbing",
        "resourcenameid": "Category.ElementPlumbing",
        "iconid": "IconFolder",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element",
        "ordernr": 30
    },
    {
        "viewname": "onProjectElements_Electricity",
        "resourcenameid": "Category.ElementElectricity",
        "iconid": "IconFolder",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element",
        "ordernr": 32
    },
    {
        "viewname": "onProjectElements_Mechanical",
        "resourcenameid": "Category.ElementMechanical",
        "iconid": "IconFolder",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element",
        "ordernr": 34
    },
    {
        "viewname": "onProjectElements_Construction",
        "resourcenameid": "Category.ElementConstruction",
        "iconid": "IconFolder",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element",
        "ordernr": 35
    },
    {
        "viewname": "onProjectElements_Terrain",
        "resourcenameid": "Category.ElementTerrain",
        "iconid": "IconFolder",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element",
        "ordernr": 36
    },
    {
        "viewname": "onProjectElements_Inventary",
        "resourcenameid": "Category.ElementInventary",
        "iconid": "IconFolder",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element",
        "ordernr": 37
    },
    {
        "viewname": "onProjectElements_Structural",
        "resourcenameid": "Category.ElementStructural",
        "iconid": "IconFolder",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element",
        "ordernr": 38
    },
    {
        "viewname": "onProjectElements_Clash",
        "resourcenameid": "Category.Collision",
        "iconid": "IconCollision",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Collision",
        "ordernr": 39
    },
    {
        "viewname": "onProjectIssues",
        "resourcenameid": "Category.Issue",
        "iconid": "IconIssue",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Issue",
        "ordernr": 41
    }
]

Get information about an "Object Navigator" item (objectview)

Resource: objectviews/<objectview_name>

URL: https://api-stage.bimplus.net/v2/<team_slug>/objectviews/<objectview_name>

Example: https://api-stage.bimplus.net/v2/bimplus/objectviews/onProjectElements_Building

GET

Get information about a particular objectview

Headers

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

Status

Status: 200 OK

JSON

[
    {
        "viewname": "onProjectElements_Building",
        "resourcenameid": "Category.ElementBuilding",
        "iconid": "IconArchitectureWall",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element",
        "ordernr": "21"
    }
]

Get the properties of the object (objectview)

Resource: objectviews/<objectview_name>/properties

URL: https://api-stage.bimplus.net/v2/<team_slug>/objectviews/<objectview_name>/properties

Example: https://api-stage.bimplus.net/v2/bimplus/objectviews/onProjectElements_Building/properties

GET

Get the properties of a particular objectview

Headers

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

Status

Status: 200 OK

JSON

[
    {
        "name": "ObjectID",
        "ordernr": 1,
        "datatype": "uniqueidentifier",
        "isdefault": null,
        "categorynameid": null,
        "resourcenameid": null,
        "proporder": null,
        "converter": null,
        "browsable": "false",
        "iconid": null,
        "filterable": null
    },
    {
        "name": "Nr",
        "ordernr": 2,
        "datatype": "int",
        "isdefault": null,
        "categorynameid": "Category.General",
        "resourcenameid": null,
        "proporder": null,
        "converter": null,
        "browsable": null,
        "iconid": null,
        "filterable": null
    },
    {
        "name": "Name",
        "ordernr": 3,
        "datatype": "nvarchar",
        "isdefault": "true",
        "categorynameid": "Category.General",
        "resourcenameid": "Name",
        "proporder": null,
        "converter": "Converter_PPName",
        "browsable": null,
        "iconid": null,
        "filterable": null
    },
    {
        "name": "Description",
        "ordernr": 4,
        "datatype": "nvarchar",
        "isdefault": "true",
        "categorynameid": "Category.General",
        "resourcenameid": "Description",
        "proporder": null,
        "converter": null,
        "browsable": null,
        "iconid": null,
        "filterable": null
    },
    {
        "name": "DivisionID",
        "ordernr": 5,
        "datatype": "uniqueidentifier",
        "isdefault": null,
        "categorynameid": null,
        "resourcenameid": null,
        "proporder": null,
        "converter": null,
        "browsable": "false",
        "iconid": null,
        "filterable": null
    },
    {
        "name": "Division",
        "ordernr": 6,
        "datatype": "nvarchar",
        "isdefault": "true",
        "categorynameid": "Category.General",
        "resourcenameid": "Property.Model",
        "proporder": null,
        "converter": null,
        "browsable": null,
        "iconid": null,
        "filterable": null
    },
    {
        "name": "ModelType",
        "ordernr": 7,
        "datatype": "uniqueidentifier",
        "isdefault": "true",
        "categorynameid": "Category.General",
        "resourcenameid": "Property.Discipline",
        "proporder": null,
        "converter": "Converter_ElementType",
        "browsable": null,
        "iconid": null,
        "filterable": null
    },
    {
        "name": "ElementTyp",
        "ordernr": 8,
        "datatype": "uniqueidentifier",
        "isdefault": "true",
        "categorynameid": "Category.General",
        "resourcenameid": "Type",
        "proporder": null,
        "converter": "Converter_ElementType",
        "browsable": null,
        "iconid": null,
        "filterable": null
    },
    {
        "name": "Weight",
        "ordernr": 9,
        "datatype": "float",
        "isdefault": null,
        "categorynameid": "Category.Geometry",
        "resourcenameid": "Mass",
        "proporder": null,
        "converter": "Converter_Mass",
        "browsable": null,
        "iconid": null,
        "filterable": null
    },
    {
        "name": "Volume",
        "ordernr": 10,
        "datatype": "float",
        "isdefault": null,
        "categorynameid": "Category.Geometry",
        "resourcenameid": "Volume",
        "proporder": null,
        "converter": "Converter_Volume",
        "browsable": null,
        "iconid": null,
        "filterable": null
    },
    {
        "name": "Area",
        "ordernr": 11,
        "datatype": "float",
        "isdefault": null,
        "categorynameid": "Category.Geometry",
        "resourcenameid": "Area",
        "proporder": null,
        "converter": "Converter_Area",
        "browsable": null,
        "iconid": null,
        "filterable": null
    },
    {
        "name": "Length",
        "ordernr": 12,
        "datatype": "float",
        "isdefault": "true",
        "categorynameid": "Category.Geometry",
        "resourcenameid": "Element.Geometry.Length",
        "proporder": null,
        "converter": "Converter_Length",
        "browsable": null,
        "iconid": null,
        "filterable": null
    },
    {
        "name": "Width",
        "ordernr": 13,
        "datatype": "float",
        "isdefault": "true",
        "categorynameid": "Category.Geometry",
        "resourcenameid": "Element.Geometry.Width",
        "proporder": null,
        "converter": "Converter_Length",
        "browsable": null,
        "iconid": null,
        "filterable": null
    }
]

Get the required object's(objectview's) details from input objectview list reference

Resource: objectviews/content

URL: https://api-stage.bimplus.net/v2/<team_slug>/objectviews/content

Example: https://api-stage.bimplus.net/v2/bimplus/objectviews/content

JSON Structure:

Name	Mandatory / Optional	Type	Description
name	mandatory	string	Name of the resource/objectview
elementsguid	optional	object	List of object id's whose details has to be found
filter	optional	object	The properties that could be used as filters

POST

Get the required objectview's details from input object list reference

Headers

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

JSON

{
    "name": "onProjectElements_Building",
    "elementsguid": [
        "1F3E2F56-A94F-4486-97F5-21ACDF7A76AE",
        "54978C4C-B18B-4420-819D-405234FC11B4",
        "EB0472BE-1353-4E47-BE76-875924E0586F"
    ],
    "filter": [
        "ObjectId",
        "DivisionId",
        "Name",
        "Width",
        "ElementTyp"
    ]
}

Status

Status: 200 OK

JSON

[
    {
        "objectid": "1f3e2f56-a94f-4486-97f5-21acdf7a76ae",
        "divisionid": "06a78b8f-c692-46d1-a16e-f878b6a86f17",
        "name": "Wall",
        "elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
        "width": 300
    },
    {
        "objectid": "54978c4c-b18b-4420-819d-405234fc11b4",
        "divisionid": "06a78b8f-c692-46d1-a16e-f878b6a86f17",
        "name": "Wall",
        "elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
        "width": 300
    },
    {
        "objectid": "eb0472be-1353-4e47-be76-875924e0586f",
        "divisionid": "06a78b8f-c692-46d1-a16e-f878b6a86f17",
        "name": "Wall",
        "elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
        "width": 300
    }
]

Delete the object view

Resource: objectviews/<objectview_id>

URL: https://api-stage.bimplus.net/v2/<team_slug>/objectviews/<objectview_id>

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

DELETE

Deletes a specified user defined view(object view).

Headers

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

Status

Status: 200 OK

Create a new hierarchy

Resource: usersettings/hierarchies/<hierarchy_id>

URL: https://api-stage.bimplus.net/v2/<team_slug>/hierarchies/<hierarchy_id>

Example: https://api-stage.bimplus.net/v2/bimplus/hierarchies/aaaaa213-1a6e-4aa2-b032-d5aeb8f31c97

JSON Structure:

Name	Mandatory / Optional	Type	Description
moduleId	mandatory	string(guid)	Guid of the module
objectId	mandatory	string(guid)	Guid of the object type
userId	mandatory	string(guid)	Guid of the user
category	optional	string	Name of the category(default is "ObjectNavigator")
oneExtendedData	mandatory	object	Additional information
valueKey	mandatory	string	key name
valueName	mandatory	string	Value of the key
value	mandatory	string	Content of stored value
isDefault	optional	boolean	Whether it is the default value
dataSmallInt	optional	integer	Additional info about the value

POST

Create a new hierarchy

Headers

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

JSON

{
    "objectId": "1F15C447-E511-4FC1-940B-13639F973C52",
    "moduleId": "3e3b1ae3-8955-4c4e-803e-2d56a4a8e50d",
    "userId": "A612E213-1A6E-4AA2-B032-D5AEB8F31C97",
    "category": "ObjectNavigator",
    "oneExtendedData": {
        "valueKey": "[onProjectElements_Building]onProjectElements_Building",
        "valueName": "test xxx",
        "value": "[I]Name[I]Length[F][0]<1700[2]>=415[4]=0[10]AND[11]AND[12]AND[13]AND[14]AND",
        "isDefault": "0",
        "dataSmallInt": "1"
    }
}

Status

Status: 200 OK

JSON

{
    "objectId": "1F15C447-E511-4FC1-940B-13639F973C52",
    "moduleId": "3e3b1ae3-8955-4c4e-803e-2d56a4a8e50d",
    "userId": "A612E213-1A6E-4AA2-B032-D5AEB8F31C97",
    "category": "ObjectNavigator",
    "oneExtendedData": {
        "valueKey": "[onProjectElements_Building]onProjectElements_Building",
        "valueName": "test xxx",
        "value": "[I]Name[I]Length[F][0]<1700[2]>=415[4]=0[10]AND[11]AND[12]AND[13]AND[14]AND",
        "isDefault": "0",
        "dataSmallInt": "1"
    }
}

Create a list of hierarchies

Resource: usersettings/hierarchies?$operation=createlist

URL: https://api-stage.bimplus.net/v2/<team_slug>/usersettings/hierarchies?$operation=createlist

Example: https://api-stage.bimplus.net/v2/bimplus/usersettings/hierarchies?$operation=createlist

JSON Structure:

Name	Mandatory / Optional	Type	Description
moduleId	mandatory	string(guid)	Guid of the module
objectId	mandatory	string(guid)	Guid of the object type
userId	mandatory	string(guid)	Guid of the user
category	optional	string	Name of the category(default is "ObjectNavigator")
oneExtendedData	mandatory	object	Additional information
valueKey	mandatory	string	key name
valueName	mandatory	string	Value of the key
value	mandatory	string	Content of stored value
isDefault	optional	boolean	Whether it is the default value
dataSmallInt	optional	integer	Additional info about the value

POST

Create a new hierarchy

Headers

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

JSON

{
    "objectId": "1F15C447-E511-4FC1-940B-13639F973C52",
    "moduleId": "3e3b1ae3-8955-4c4e-803e-2d56a4a8e50d",
    "userId": "A612E213-1A6E-4AA2-B032-D5AEB8F31C97",
    "category": "ObjectNavigator",
    "extendedDataList": [
        {
            "userSettingId": "1FABF447-E511-4FC1-940B-D5AEB8F31C97",
            "valueKey": "[onProjectElements_Building]onProjectElements_Building",
            "valueName": "pokus 001",
            "value": "[I]Name[I]Length[F][0]<7777[2]>=415[4]=0[10]AND[11]AND[12]AND[13]AND[14]AND",
            "isDefault": "false",
            "dataSmallInt": "1"
        },
        {
            "userSettingId": "53AB1047-E611-4FC1-940B-D5AEB8F31012",
            "valueKey": "[onProjectElements_Building]onProjectElements_Building",
            "valueName": "pokus 002",
            "value": "[I]Name[I]Length[F][0]<2222[2]>=415[4]=0[10]AND[11]AND[12]AND[13]AND[14]AND",
            "isDefault": "false",
            "dataSmallInt": "1"
        }
    ]
}

Status

Status: 200 OK

JSON

{
    "objectId": "1F15C447-E511-4FC1-940B-13639F973C52",
    "moduleId": "3e3b1ae3-8955-4c4e-803e-2d56a4a8e50d",
    "userId": "A612E213-1A6E-4AA2-B032-D5AEB8F31C97",
    "category": "ObjectNavigator",
    "extendedDataList": [
        {
            "userSettingId": "1FABF447-E511-4FC1-940B-D5AEB8F31C97",
            "valueKey": "[onProjectElements_Building]onProjectElements_Building",
            "valueName": "pokus 001",
            "value": "[I]Name[I]Length[F][0]<7777[2]>=415[4]=0[10]AND[11]AND[12]AND[13]AND[14]AND",
            "isDefault": "false",
            "dataSmallInt": "1"
        },
        {
            "userSettingId": "53AB1047-E611-4FC1-940B-D5AEB8F31012",
            "valueKey": "[onProjectElements_Building]onProjectElements_Building",
            "valueName": "pokus 002",
            "value": "[I]Name[I]Length[F][0]<2222[2]>=415[4]=0[10]AND[11]AND[12]AND[13]AND[14]AND",
            "isDefault": "false",
            "dataSmallInt": "1"
        }
    ]
}

Create a complete new hierarchy structure

Resource: services/applyhierarchy

URL: https://api-stage.bimplus.net/v2/<team_slug>/services/applyhierarchy

Example: https://api-stage.bimplus.net/v2/bimplus/services/applyhierarchy

JSON Structure:

Name	Mandatory / Optional	Type	Description
projectId	mandatory	string(guid)	Id of the project for which the structure will be created
userSettingId	mandatory	string(guid)	Id of the user settings required for the hierarchy definition
hierarchyDefinition	mandatory	string	Definition of the hierarchy
name	mandatory	string	Name of the hierarchy
description	optional	string	Description of the hierarchy
structureType	optional	string	Structure type
elementsId	optional	Array of strings(guid)	List of elements guid connected to the hierarchy structure

POST

Create a complete new hierarchy structure

Headers

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

JSON

{
    "runAsync": "false",
    "applyHierarchy": {
        "projectId": "01C52808-6561-47F6-833E-B62D05DA8A8E",
        "hierarchyDefinition": "[I]tabAttribGeneral.Name[I]tabAttribGeometry.Length[I] tabAttribGeometry.Width[I][8807e401-6e3c-4536-88e1-e834d4de745d].Value",
        "name": "Navigator 1",
        "description": "Test for HierarchyNavigator",
        "structureType": "CostStructure",
        "elementsId": [
            "803312C0-26B6-49BE-A607-4319F1B32383",
            "51FEF0FA-437B-4410-B9BE-39B9E15D440F",
            "71D472FD-96A5-4174-8A5A-460DEB8E88E1"
        ]
    }
}

Status

Status: 201 CREATED

JSON

{
    "applyHierarchy": {
        "projectId": "01c52808-6561-47f6-833e-b62d05da8a8e",
        "hierarchyDefinition": "[I]tabAttribGeneral.Name[I]tabAttribGeometry.Length[I]tabAttribGeometry.Width[I] [8807e401-6e3c-4536-88e1-e834d4de745d].Value",
        "name": "Navigator 1",
        "description": "Test for HierarchyNavigator",
        "structureType": "CostStructure",
        "elementsId": [
            "803312c0-26b6-49be-a607-4319f1b32383",
            "51fef0fa-437b-4410-b9be-39b9e15d440f",
            "71d472fd-96a5-4174-8a5a-460deb8e88e1"
        ],
        "result": {
            "projectId": "01c52808-6561-47f6-833e-b62d05da8a8e",
            "parentId": "01c52808-6561-47f6-833e-b62d05da8a8e",
            "name": "Navigator 1",
            "description": "Test for HierarchyNavigator",
            "type": "CostStructure",
            "nr": 45,
            "color": 0,
            "id": "dd71620e-af8f-4496-88a5-cc2be1f1747d"
        }
    },
    "runAsync": false
}

Get all the user hierarchies using the user & module information

Resource: usersettings/heirarchies?moduleId=xxx;userId=yyy;category=zzz

URL: https://api-stage.bimplus.net/v2/<team_slug>/usersettings/heirarchies?moduleId=xxx;userId=yyy;category=zzz

Example: https://api-stage.bimplus.net/v2/bimplus/usersettings/heirarchies?moduleId=3e3b1ae3-8955-4c4e-803e-2d56a4a8e50d;userId=a612e213-1a6e-4aa2-b032-d5aeb8f31c97;category=ObjectNavigator

JSON Structure:

Name	Mandatory / Optional	Type	Description
moduleid	mandatory	guid	Id of the module
userid	mandatory	guid	Id of the user
category	optional	string	category name (default category is "ObjectNavigator")

GET

Get all the user hierarchies using the user & module information

Headers

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

Status

Status: 200 OK

JSON

[
    {
        "attribusersettingid": "511d2c35-d7a6-4e76-82f0-172a64c322b6",
        "objectid": "1f15c447-e511-4fc1-940b-13639f973c52",
        "module": "3e3b1ae3-8955-4c4e-803e-2d56a4a8e50d",
        "userid": "a612e213-1a6e-4aa2-b032-d5aeb8f31c97",
        "category": "ObjectNavigator",
        "isdefault": false,
        "valuekey": "[onProjectElements_Building]",
        "valuename": "onProjectElements_Building",
        "value": "Name[I]Description[I]Division[I]ModelType[I]ElementTyp[I]Length[I]Width",
        "datasmallint": null,
        "revision": null
    },
    {
        "attribusersettingid": "909c9802-a339-4a60-8fff-64ea495f6136",
        "objectid": "1f15c447-e511-4fc1-940b-13639f973c52",
        "module": "3e3b1ae3-8955-4c4e-803e-2d56a4a8e50d",
        "userid": "a612e213-1a6e-4aa2-b032-d5aeb8f31c97",
        "category": "ObjectNavigator",
        "isdefault": false,
        "valuekey": "[onProjectElements_Electricity]",
        "valuename": "onProjectElements_Electricity",
        "value": "Name[I]Description[I]Division[I]ModelType[I]ElementTyp[I]Length[I]Width",
        "datasmallint": null,
        "revision": null
    },
    {
        "attribusersettingid": "e4ca5278-98da-4809-9582-6815bbab2200",
        "objectid": "1f15c447-e511-4fc1-940b-13639f973c52",
        "module": "3e3b1ae3-8955-4c4e-803e-2d56a4a8e50d",
        "userid": "a612e213-1a6e-4aa2-b032-d5aeb8f31c97",
        "category": "ObjectNavigator",
        "isdefault": false,
        "valuekey": "[onProjectElements_MEP]",
        "valuename": "onProjectElements_MEP",
        "value": "Name[I]Description[I]Division[I]ModelType[I]ElementTyp[I]Weight[I]Length[I]Width",
        "datasmallint": 0,
        "revision": null
    }
]

Get the details of a hierarchy

Resource: usersettings/heirarchies/hierarchy_id>

URL: https://api-stage.bimplus.net/v2/<team_slug>/usersettings/heirarchies/hierarchy_id>

Example: https://api-stage.bimplus.net/v2/bimplus/usersettings/heirarchies/B39AD364-F049-42E3-A936-3FD2871EB4D4

GET

Get information about a particular hierarchy

Headers

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

Status

Status: 200 OK

JSON

{
    "attribusersettingid": "b39ad364-f049-42e3-a936-3fd2871eb4d4",
    "objectid": "1f15c447-e511-4fc1-940b-13639f973c52",
    "module": "3e3b1ae3-8955-4c4e-803e-2d56a4a8e50d",
    "userid": "a612e213-1a6e-4aa2-b032-d5aeb8f31c97",
    "category": "ObjectNavigator",
    "isdefault": false,
    "valuekey": "[onProjectElements_Building]onProjectElements_Building",
    "valuename": "Hierarchie Nr.1",
    "value": "[I]Name[I]Length[F][0]<3000[2]>=215[4]=0[10]AND[11]AND[12]AND[13]AND[14]AND[I]Width[F][0]<1000[2]>400[10]AND[11]AND[12]AND[13]AND[14]AND",
    "datasmallint": 1,
    "revision": null
}

Get details about a list of hierarchies

Resource: usersettings/heirarchies?$operation=getlist

URL: https://api-stage.bimplus.net/v2/<team_slug>/usersettings/heirarchies?$operation=getlist

Example: https://api-stage.bimplus.net/v2/bimplus/usersettings/heirarchies?$operation=getlist

JSON Structure:

Name	Mandatory / Optional	Type	Description
userSettingsListId	mandatory	object	List of hierarchy ids

GET

Get details about a list of hierarchies

Headers

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

JSON

{
 "userSettingsListId": [
 "AAAAA213-1111-4AA2-B032-D5AEB8F31C97",
 "AAAAA213-2222-4AA2-B032-D5AEB8F31C97"
 ]
}

Status

Status: 200 OK

JSON

[
    {
        "attribusersettingid": "511d2c35-d7a6-4e76-82f0-172a64c322b6",
        "objectid": "1f15c447-e511-4fc1-940b-13639f973c52",
        "module": "3e3b1ae3-8955-4c4e-803e-2d56a4a8e50d",
        "userid": "a612e213-1a6e-4aa2-b032-d5aeb8f31c97",
        "category": "ObjectNavigator",
        "isdefault": false,
        "valuekey": "[onProjectElements_Building]",
        "valuename": "onProjectElements_Building",
        "value": "Name[I]Description[I]Division[I]ModelType[I]ElementTyp[I]Length[I]Width",
        "datasmallint": null,
        "revision": null
    },
    {
        "attribusersettingid": "909c9802-a339-4a60-8fff-64ea495f6136",
        "objectid": "1f15c447-e511-4fc1-940b-13639f973c52",
        "module": "3e3b1ae3-8955-4c4e-803e-2d56a4a8e50d",
        "userid": "a612e213-1a6e-4aa2-b032-d5aeb8f31c97",
        "category": "ObjectNavigator",
        "isdefault": false,
        "valuekey": "[onProjectElements_Electricity]",
        "valuename": "onProjectElements_Electricity",
        "value": "Name[I]Description[I]Division[I]ModelType[I]ElementTyp[I]Length[I]Width",
        "datasmallint": null,
        "revision": null
    }
]

Delete the hierarchy

Resource: usersettings/hierarchies/<hierarchy_id>

URL: https://api-stage.bimplus.net/v2/<team_slug>/usersettings/hierarchies/<hierarchy_id>

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

DELETE

Deletes a specific hierarchy.

Headers

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

Status

Status: 200 OK

Delete the list of hierarchies

Resource: usersettings/hierarchies?$operation=deletelist

URL: https://api-stage.bimplus.net/v2/<team_slug>/usersettings/hierarchies?$operation=deletelist

Example: https://api-stage.bimplus.net/v2/bimplus/usersettings/hierarchies?$operation=deletelist

JSON Structure:

Name	Mandatory / Optional	Type	Description
userSettingsListId	mandatory	object	List of hierarchy ids that has to be deleted

DELETE

Deletes the list of hierarchies as specified in the request

Headers

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

JSON

{
 "userSettingsListId": [
 "AAAAA213-1111-4AA2-B032-D5AEB8F31C97",
 "AAAAA213-2222-4AA2-B032-D5AEB8F31C97"
 ]
}

Status

Status: 200 OK

Delete all the hierarchies filtered by additional info

Resource: usersettings/hierarchies?moduleId=xxx;userId=<yyy>;category=<name>;objectId=<zzz>

URL: https://api-stage.bimplus.net/v2/<team_slug>/usersettings/hierarchies?moduleId=<xxx>;userId=<yyy>;category=<name>;objectId=<zzz>

Example: https://api-stage.bimplus.net/v2/bimplus/usersettings/hierarchies?moduleId=3e3b1ae3-8955-4c4e-803e-2d56a4a8e50d;userId=a612e213-1a6e-4aa2-b032-d5aeb8f31c97;category=ObjectNavigator;objectId=1F15C447-E511-4FC1-940B-13639F973C52

JSON Structure:

Name	Mandatory / Optional	Type	Description
moduleId	mandatory	string(guid)	Id of the module
userId	mandatory	string(guid)	Id of the user
objectId	optional	string(guid)	Id of the object (default is "1F15C447-E511-4FC1-940B-13639F973C52")
Category	optional	string	Name of the category (default is "ObjectNavigator")

DELETE

Deletes all the hierarchies filtered by additional info specified as query strings.

Headers

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

JSON

{
 "userSettingsListId": [
 "AAAAA213-1111-4AA2-B032-D5AEB8F31C97",
 "AAAAA213-2222-4AA2-B032-D5AEB8F31C97"
 ]
}

Status

Status: 200 OK

Create a property setting

Resource: propertysettings/<propertysetting_id>

URL: https://api-stage.bimplus.net/v2/<team_slug>/propertysettings/<propertysetting_id>

Example: https://api-stage.bimplus.net/v2/bimplus/propertysettings/aaaaa213-1a6e-4aa2-b032-d5aeb8f31c97

JSON Structure:

Name	Mandatory / Optional	Type	Description
attributes	mandatory	object	List of attributes

POST

Create a new property setting

Headers

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

JSON

{
    "attributes": {
        "general": [
            "Name",
            "Description"
        ],
        "quantity": [
            "Length",
            "Width",
            "Height",
            "Volume"
        ],
        "freeattribute": [
            "59AB0000-4100-4020-B0D0-01D3EEDF5389",
            "CFF9B525-DE61-4E66-A040-BF7437495BEB"
        ],
        "elementstates": [
            "State"
        ]
    }
}

Status

Status: 201 CREATED

JSON

{
    "attributes": {
        "general": [
            "Name",
            "Description"
        ],
        "quantity": [
            "Length",
            "Width",
            "Height",
            "Volume"
        ],
        "freeattribute": [
            "59AB0000-4100-4020-B0D0-01D3EEDF5389",
            "CFF9B525-DE61-4E66-A040-BF7437495BEB"
        ],
        "elementstates": [
            "State"
        ]
    }
}

Get the property setting details

Resource: propertysettings/<propertysetting_id>

URL: https://api-stage.bimplus.net/v2/<team_slug>/propertysettings/<propertysetting_id>

Example: https://api-stage.bimplus.net/v2/bimplus/propertysettings/B39AD364-F049-42E3-A936-3FD2871EB4D4

GET

Get information about a particular property setting

Headers

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

Status

Status: 200 OK

JSON

{
    "attributes": {
        "general": [
            "Name",
            "Description"
        ],
        "quantity": [
            "Length",
            "Width",
            "Height",
            "Volume"
        ],
        "freeattribute": [
            "59AB0000-4100-4020-B0D0-01D3EEDF5389",
            "CFF9B525-DE61-4E66-A040-BF7437495BEB"
        ],
        "elementstates": [
            "State"
        ]
    }
}

Update the property setting

Resource: propertysettings/<propertysetting_id>

URL: https://api-stage.bimplus.net/v2/<team_slug>/propertysettings/<propertysetting_id>

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

JSON Structure:

Name	Mandatory / Optional	Type	Description
attributes	mandatory	object	List of attributes

PUT

Update the property setting

Headers

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

JSON

{
    "attributes": {
        "general": [
            "Name",
            "Description"
        ],
        "quantity": [
            "Length",
            "Width",
            "Height",
            "Volume"
        ],
        "freeattribute": [
            "59AB0000-4100-4020-B0D0-01D3EEDF5389",
            "CFF9B525-DE61-4E66-A040-BF7437495BEB"
        ],
        "elementstates": [
            "State"
        ]
    }
}

Status

Status: 200 OK

Delete the property setting

Resource: propertysettings/<propertysetting_id>

URL: https://api-stage.bimplus.net/v2/<team_slug>/propertysettings/<propertysetting_id>

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

DELETE

Delete all the issues belonging to a specified project.

Headers

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

Status

Status: 200 OK

Space shortcuts

Page tree

4. Bimplus API Reference

Project relevant services

Administration relevant services

Other services

Project Service

Model Service

Object Service

ElementType Service

Attachment Service

Issue Service

Pin Service

Comment Service

Import Service

Slideshow Service

Hyperlink Service

Structure Service

Clash Service

Authorization Service

User Management Service

Team Management Service

Membership Management Service

Rights & Roles Service

Messaging Service

Log Service

Bimplus Windows Explorer related Services

ElementType Service

Get the element types

Get the element type properties

Get the list of existing layers

Attachment Service

Get Attachment information

Download the attachment

Update the attachment

Delete the Attachment

Issue Service

Get details of the issue

Get all the issue types (Not implemented)

Get details of the issue type (Not implemented)

Create a new pin for the issue

Get all the pins of the issue

Delete all the pins from the issue

Create a new comment for the issue

Get all the comments of the issue

Delete all the comments from the issue

Create a new attachment for the issue

Get the attachment list from the issue

Delete all the attachments from the issue

Working with hyperlinks belonging to an issue

Update the issue

Delete the issue

Pin Service

Get details of the pin

Update the pin

Delete the pin

Comment Service

Get details of the comment

Update the comment

Delete the comment

Import Service

Replace a model by importing SketchUp and IFC files

Slideshow Service

Create a new slideshow

Get the slideshow list from a project

Delete all the slideshows from a project

Get details of the slideshow

Update the slideshow

Delete the slideshow

Create a new slide for a slideshow

Get the slide list from a slideshow

Get the details of a slide

Update the details of a slide

Delete a slide from a slideshow

Create a thumbnail for a slideshow

Download the thumbnail from a slideshow

Create a thumbnail for a slide

Download the thumbnail from a slide

Working with attachments/comments/hyperlinks belonging to a slide

Hyperlink Service