Versions Compared

Key

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

...

  • Node: Objects with no graphical representation
  • Geometry: Objects with graphical representation (See Geometry)

Please see the detailed structure of the issue in the Object Model

Anchor
createObject
createObject

...

Deck of Cards
idbimObjCreateHyperlink
Card
defaulttrue
labelURL / Resource / JSON Structure
 Resource: objects/<object_id>hyperlinks 

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

Examplehttps://api-stage.bimplus.net/v2/bimplus/objects/7cf910cb-e357-43f6-aa3a-b45c26380f75/hyperlinks

JSON Structure:

Name

Mandatory / Optional

Type

Description

orderNumber

will be ignored

integer

The ordering number of the hyperlink

name

mandatory

string

Name of the hyperlink

url

mandatory

string

The actual url

id

will be ignored

string (guid)

Id of the hyperlink

typeoptionalstringHyperlink type. Could be either none - link to web site, or "Attachment" - link to download url
Card
labelHTTP Method
 POST
Card
labelDescription
Create a new hyperlink for the object.
Card
labelRequest
Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: multipart/form-data
Code Block
borderColorRed
langxml
titleJSON
{
    "name": "My website",
    "url": https://www.bimplus.net/
}
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
Status: 200 Created
Code Block
borderColorRed
langxml
titleJSON
{
    "orderNumber": 1,
    "name": "My website",
    "url": "https://www.bimplus.net/",
    "id": "e72e6ddd-63f4-40a3-b820-a32300e14c31"
}

...