Versions Compared

Old Version 44

changes.mady.by.user Jayaraj Purushothaman

Saved on

compared with

New Version 45

changes.mady.by.user Jayaraj Purushothaman

Saved on

Key

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

...


Anchor
pinService
pinService

Pin Service

...

Anchor
getPinDetails
getPinDetails

Get details of the pin
Deck of Cards
idbimGetPinDetails
Card
labelImplementation Status

 Service available !

Card
labelHTTP Method

GET

Card
defaulttrue
labelURL / Resource / JSON Structure

Resource: pins/<pin_id> 

URL: https://api.bimplus.net/v2/<team>/pins/<pin_id>

Example:

Card
labelDescription

Get details of a specified pin.

Card
labelRequest
Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK


Code Block
borderColorRed
langxml
titleJSON

 Anchor
updatePin
updatePin
Update the pin
 Deck of Cards
idbimPinUpdate
 Card
labelImplementation Status
 Service available !
 Card
labelHTTP Method
PUT
 Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: pins/<pin_id> 
URL: https://api.bimplus.net/v2/<team>/pins/<pin_id>
Example:
JSON Structure: 
 Name 
 Mandatory / Optional 
 Type 
 Description 
 issueId 
 
 string (guid) 
 The id of the issue to which the pin is related 
 objectId 
 
 
 The id of the object to which the pin is related 
 position 
 optional 
 
 
 normalVector 
 optional 
 
 
 createdAt 
 optional 
 string (date) 
 The creation date 
 Card
labelDescription
Update or replace a specified existing pin with a new one.
 Card
labelRequest
 Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json


 Code Block
borderColorRed
langxml
titleJSON
 Card
labelResponse
 Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK


 Anchor
deletePin
deletePin
Delete the pin
 Deck of Cards
idbimGetPinDetails
 Card
labelImplementation Status
 Service available !
 Card
labelHTTP Method
DELETE
 Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: pins/<pin_id> 
URL: https://api.bimplus.net/v2/<team>/pins/<pin_id>
Example:
 Card
labelDescription
Deletes a specified pin.
 Card
labelRequest
 Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

 Card
labelResponse
 Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK

...