Page History

Hyperlink Service

...

Hyperlink Service

...

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

...

Anchor

	getHyperlinkDetails
	getHyperlinkDetails

Get details of the hyperlink

Deck of Cards

id	bimGetHyperlink

Card

default	true
label	URL / Resource / JSON Structure

Resource: hyperlink/<hyperlink_id>

URL: https://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

label	HTTP Method

GET

Card

label	Description

Get details of a specified hyperlink.

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

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

Anchor

	updateHyperlink
	updateHyperlink

Update the hyperlink

Deck of Cards

id	bimHyperlinkUpdate

Card

default	true
label	URL / Resource / JSON Structure

Resource: hyperlink/<hyperlink_id>

URL: https://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

label	HTTP Method

PUT

Card

label	Description

Update the specified hyperlink.

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

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Anchor

	deleteHyperlink
	deleteHyperlink

Delete the hyperlink

Deck of Cards

id	bimDeleteHyperlink

Card

default	true
label	URL / Resource / JSON Structure

Resource: hyperlink/<hyperlink_id>

URL: https://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

label	HTTP Method

DELETE

Card

label	Description

Deletes a specified hyperlink.

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 2

New Version 3

Key

Hyperlink Service

Hyperlink Service

Get details of the hyperlink

Update the hyperlink

Delete the hyperlink