Versions Compared

Old Version 2

changes.mady.by.user Jayaraj Purushothaman

Saved on

compared with

New Version Current

changes.mady.by.user Noema Bradnanska

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Comment Service

...

 

Comment Service

...

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

Anchor
getComment
getComment

Get details of the comment
Deck of Cards
idbimGetComment


Card
defaulttrue
labelURL / 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
labelHTTP Method
 GET


Card
labelDescription
 Get details of a specified comment.


Card
labelRequest


Code Block
borderColorGreen
langxml
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json



Card
labelResponse


Code Block
borderColorGreen
langxml
titleStatuslangxml
Status: 200 OK


Code Block
borderColorRed
langxml
titleJSONlangxml
{
	"id": "db540336-47a3-426e-b3bf-1e532bfac8ea",
    "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,
        "fullname": "test test",
        "displayname": "test test [test test]",
        "shortdisplayname": "test test"
        },
	"status": null,
    "verbalStatus": null,
   "info": null,
 "hyperlinks": [
		{
			"id": "6943aa22-36d4-4f9d-883b-e829838d7fbc",
			"objectId": "6c4c82eb-92f4-40ff-9e49-98d565cdf35b",
			"orderNumber": 1,
			"name": "1",
			"url": "bimplus.com"
		},
		],
	 "attachmentLinks": [
            {
                "id": "c77b3e31-73f6-498a-9b40-f63f894c0477",
         "gender": null,
       "objectIds": [
                    "06af7c41-fa41-4682-b337-7bd6af6a090d"
                ],
                "phoneWorkname": null"ifc01-1",
                "phoneHomefileName": null"ifc01-1.ifc",
                "faxtype": null"application/octet-stream",
        "mobile        "size": null4522,
        "birthDate        "createdAt": null"2021-02-17T10:37:01.7966667",
        "address        "creator": {
                    "streetid": "04002d23-8d64-1016-9f82-95ad8f2398b3",
                    "streetNremail": "test@allplan.com",
                    "zipstatus": "Active",
              "city      "firstname": "test",
            "country        "lastname": "test",
          },
          "company": "test test",
                    "preferedLanguagefullname": null
    }"test test",
                    "displayname": "test test [test test]",
    "id                "shortdisplayname": "db540336-47a3-426e-b3bf-1e532bfac8ea"
}

...

Update the comment
Deck of Cards
idbimCommentUpdate
Card
defaulttrue
labelURL / 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

issueIdwill be ignoredstring(guid)The id of the issue

text

mandatory

string

The comment text

createdAt

will be ignored

string (date)

Creation date of the comment

modifiedAtwill be ignoredstring (date)Modified date of the comment

author

optional

object

The author of the comment

Card
labelHTTP Method
 PUT
Card
labelDescription
Update the specified comment.
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Code Block
borderColorRed
titleJSON
langxml
{
    "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": {test test"
                },
                "changed": "2021-02-17T10:37:02.28",
                "changedBy": {
                    "id": "04002d23-8d64-1016-9f82-95ad8f2398b3",
                    "email": "test@allplan.com",
                    "firstname": "test",
                    "lastname": "test"
                },
                "attachmentType": "Document",
                "sizeMB": "0",
                "version": 1,
        "id        "relatedId": "132a78a506af7c41-b523fa41-4bf24682-8382b337-7098fac3f8037bd6af6a090d",
    }
}
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
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

Deck of Cards
idbimDeleteComment
Card
defaulttrue
labelURL / Resource / JSON Structure
Card
labelHTTP Method
 DELETE
Card
labelDescription
 Deletes a specified comment.
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 200 OK
            "release": true,
                "releaseVersion": [
                    1
                ]
            }
        ]	  
}