4.15 Hyperlink Service

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

Please use the Bimplus Object Service for creating a hyperlink or to deal with the group of hyperlinks belonging to an object, issue or slide.

Resource: hyperlink/<hyperlink_id>

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

GET

Get details of a specified hyperlink.

Headers

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

Status

Status: 200 OK

JSON

{
    "orderNumber": 1,
    "name": "My website",
    "url": "https://www.bimplus.net/",
    "id": "c46d1080-0450-4f03-aa4d-a32300e018e9"
}

Resource: hyperlink/<hyperlink_id>

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

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
type	optional	string	Hyperlink type. Could be either none - link to web site, or "Attachment" - link to download url

PUT

Update the specified hyperlink.

Headers

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

JSON

{    
    "name": "My new website",
    "url": "https://www-stage.bimplus.net/"
}

Status

Status: 200 OK

JSON

{
    "orderNumber": 1,
    "name": "My website",
    "url": "https://www.bimplus.net/",
    "id": "c46d1080-0450-4f03-aa4d-a32300e018e9"
}

Resource: hyperlink/<hyperlink_id>

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

DELETE

Deletes a specified hyperlink.

Headers

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

Status

Status: 200 OK

Math Editor