Versions Compared

Key

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

...

Section
bordertrue
Column

Project relevant services

Column

Administration relevant services

Column

Other services

...

Deck of Cards
idbimDownloadSlideThumbnail
Card
labelHTTP Method
 GET
Card
defaulttrue
labelURL / Resource / JSON Structure
 Resource: slide/<slide_id>/thumbnail/download

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

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

Card
labelDescription
 Downloads the thumbnail of a slide.
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: multipart/form-data
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 200 OK

 

Anchor
hyperlinkService
hyperlinkService

Hyperlink Service

...

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

Anchor
getHyperlinkDetails
getHyperlinkDetails

Deck of Cards
idbimGetHyperlink
Card
labelHTTP Method
 GET
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: hyperlink/<hyperlink_id> 

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

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

Card
labelDescription
 Get details of a specified hyperlink.
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 200 OK
Code Block
borderColorRed
titleJSON
langxml
{
    "orderNumber": 1,
    "name": "My website",
    "url": "https://www.bimplus.net/",
    "id": "c46d1080-0450-4f03-aa4d-a32300e018e9"
}

Anchor
updateHyperlink
updateHyperlink

Deck of Cards
idbimHyperlinkUpdate
Card
labelHTTP Method
 PUT
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: hyperlink/<hyperlink_id> 

URLhttps://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

Card
labelDescription
Update the specified hyperlink.
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Code Block
borderColorRed
titleJSON
langxml
{    
    "name": "My new website",
    "url": "https://www-stage.bimplus.net/"
}
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 200 OK

Anchor
deleteHyperlink
deleteHyperlink

Deck of Cards
idbimDeleteHyperlink
Card
labelHTTP Method
 DELETE
Card
defaulttrue
labelURL / Resource / JSON Structure

Resource: hyperlink/<hyperlink_id> 

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

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

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

...