Page History

...

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

...

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

...

Anchor

	commentService
	commentService

Comment 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 ModelA particular comment belonging to an issue can be modified using the comment service.

Please use the Bimplus Issue Service for creating /deleting a pin or for getting all the pins assigned comment or to deal with the group of comments belonging to an issue.

Anchor

	getComment
	getComment

Get details of the comment

Deck of Cards

id	bimGetComment

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: comments/<comment_id>

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

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

Card

label	Description

Get details of a specified pincomment.

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

...

Deck of Cards

id	bimCommentUpdate

Card

label	HTTP Method

PUT

Card

default	true
label	URL / Resource / JSON Structure

Resource: comments/<comment_id>

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

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

JSON Structure:

mandatoryoptionalguidThe id

Name	Mandatory / Optional	Type	Description
issueId	will be ignored	string(guid)	The id of the issue
text to which the pin is relatedobjectId	mandatory	string (guid)	The id of the object to which the pin is relatedcomment text
createdAt	will be ignored	newObjectId	optional	string (guiddate)	It should be specified when the pin is assigned to another object via update	topologyNodeId	Creation date of the comment
modifiedAt	will be ignored	string (	date)	Modified date of the comment
author topology to which the pin is attachedposition	optional	object	The position author 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 comment

Card

label	Description

Update or replace a specified existing pin with a new onethe 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

Anchor

	deletePindeleteCommentdeletePin
	deleteComment

Delete the comment

Deck of Cards

id	bimDeleteComment

Card

label	HTTP Method

DELETE

Card

default	true
label	URL / Resource / JSON Structure

Resource: pinscomments/<pin<comment_id>

URL: https://api.bimplus.net/v2/comments/pins/<comment_id>

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

Card

label	Description

Deletes a specified pincomment.

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

...

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 310

New Version 311

Key

Comment Service

Get details of the comment

Delete the comment