Hyperlink Service
...
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.
| Anchor |
|---|
| getHyperlinkDetails |
|---|
| getHyperlinkDetails |
|---|
|
Get details of the hyperlink
| Deck of Cards |
|---|
|
| Card |
|---|
| | Get details of a specified hyperlink. |
| Card |
|---|
| | Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Headers |
|---|
| lang | xml |
|---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
|
| Card |
|---|
| | Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Status | lang | xml |
|---|
| Status: 200 OK
|
| Code Block |
|---|
| borderColor | Red |
|---|
| lang | xml |
|---|
| 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 |
|---|
|
| 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 | | type | optional | string | Hyperlink type. Could be either none - link to web site, or "Attachment" - link to download url |
|
| Card |
|---|
| | Update the specified hyperlink. |
| Card |
|---|
| | Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Headers | lang | xml |
|---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
| Code Block |
|---|
| borderColor | Red |
|---|
| lang | xml |
|---|
| title | JSON | lang | xml |
|---|
| {
"name": "My new website",
"url": "https://www-stage.bimplus.net/"
} |
|
| Card |
|---|
| | Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Status | lang | xml |
|---|
| Status: 200 OK
|
| Code Block |
|---|
| {
"orderNumber": 1,
"name": "My website",
"url": "https://www.bimplus.net/",
"id": "c46d1080-0450-4f03-aa4d-a32300e018e9"
} |
|
|
| Anchor |
|---|
| deleteHyperlink |
|---|
| deleteHyperlink |
|---|
|
Delete the hyperlink
| Deck of Cards |
|---|
|
| Card |
|---|
| | Deletes a specified hyperlink. |
| Card |
|---|
| | Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Headers |
|---|
| lang | xml |
|---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
|
| Card |
|---|
| | Code Block |
|---|
| borderColor | Green |
|---|
| lang | xml |
|---|
| title | Status | lang | xml |
|---|
| Status: 200 OK
|
|
|