Page History

...

Section

Column

width	25%

Messaging Service

Column

width	25%

Log Service

Column

width	50%

Bimplus Windows Explorer related Services

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

...

Anchor

	commentService
	commentService

...

Get details of the pin

Deck of Cards

id	bimGetPinDetails

Card

default	true
label	URL / Resource / JSON Structure

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

Card

label	HTTP Method

GET

Card

label	Description

Get details of a specified pin.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

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

Deck of Cards

id	bimPinUpdate

Card

default	true
label	URL / Resource / JSON Structure

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

Card

label	HTTP Method

PUT

Card

label	Description

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

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Code Block

borderColor	Red
title	JSON
lang	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

...

Delete the pin

Deck of Cards

id	bimDeletePin

Card

default	true
label	URL / Resource / JSON Structure

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

Card

label	HTTP Method

DELETE

Card

label	Description

Deletes a specified pin.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

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

Deck of Cards

id	bimGetComment

Card

default	true
label	URL / Resource / JSON Structure

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

Card

label	HTTP Method

GET

Card

label	Description

Get details of a specified comment.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

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

Deck of Cards

id	bimCommentUpdate

Card

default	true
label	URL / Resource / JSON Structure

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

Card

label	HTTP Method

PUT

Card

label	Description

Update the specified comment.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Code Block

borderColor	Red
title	JSON
lang	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

...

Delete the comment

...

id	bimDeleteComment

...

default	true
label	URL / Resource / JSON Structure

...

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

Card

label	HTTP Method

DELETE

Card

label	Description

Deletes a specified comment.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Anchor

importService

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)

Anchor

	createProjectFromIFC
	createProjectFromIFC

...

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 547

New Version 548

Key

Messaging Service

Log Service

Bimplus Windows Explorer related Services

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