Page History

...

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>

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

Card

label	HTTP Method

PUT

Card

label	Description

Update the specified hyperlink.

Card

label	Request

Code Block

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

Code Block

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

Card

label	Response

Code Block

Status: 200 OK

Code Block

title	JSON

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

...

Math Editor