Versions Compared

Old Version 446

changes.mady.by.user Jayaraj Purushothaman

Saved on

compared with

New Version 447

changes.mady.by.user Jayaraj Purushothaman

Saved on

Key

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

...

Section
Column

Project Service

Column

Model Service

Column

Object Service

Section
Column

ElementType Service

Column

Attachment Service

Column

Issue Service

Column

Pin Service

Column

Comment Service

...

Deck of Cards
idbimObjCreateHyperlink
Card
labelHTTP Method
 POST
Card
defaulttrue
labelURL / Resource / JSON Structure
 Resource: objects/<object_id>attachments id>hyperlinks 

URL: https://api-stage.bimplus.net/v2/<team_slug>/objects/<object_id>attachmentsid>/hyperlinks

Example: https://api-stage.bimplus.net/v2/bimplus/objects/7cf910cb-e357-43f6-aa3a-b45c26380f75/attachmentshyperlinks

JSON Structure: Please note that all the information required for this call will be taken from the document that you attach and hence the request of this call has no body.

Name

Mandatory / Optional

Type

Description

orderNumber

will be ignored

stringinteger

The id ordering number of the project objects to which the file has to be attachedhyperlink

name

will be ignoredmandatory

string

Name of the file to be attached to the projecthyperlink

url

will be ignoredmandatory

string

Mime type

id

will be ignored

integer

Size of the file to be attached to the project

objectIdwill be ignoredobjectThe user who created the attachment

string (guid)

Id of the hyperlink

Card
labelDescription
Create a new hyperlink for the object.
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: multipart/form-data
Code Block
borderColorRed
titleJSON
langxml
{
    "name": "My website",
    "url": "https://www.bimplus.net/",
    "objectId": "e87c5a27-34a0-457b-9d53-92ed896539a9"
}
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 201 Created
Code Block
borderColorRed
titleJSON
langxml
{
    "orderNumber": 1,
    "name": "My website",
    "url": "https://www.bimplus.net/",
    "id": "e72e6ddd-63f4-40a3-b820-a32300e14c31"
}

...

Deck of Cards
idbimGetObjHyperlinks
Card
labelHTTP Method
 GET
Card
defaulttrue
labelURL / Resource / JSON Structure
 Resource: objects/<object_id>hyperlinks 

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

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

Card
labelDescription
 Get all the hyperlinks belonging to a specified object.
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 200 OK
Code Block
borderColorRed
titleJSON
langxml
[
    {
        "orderNumber": 1,
        "name": "My website",
        "url": "https://www.bimplus.net/",
        "id": "c46d1080-0450-4f03-aa4d-a32300e018e9"
    },
    {
        "orderNumber": 2,
        "name": "My second website2website",
        "url": "https://www-stage.bimplus.net/",
        "id": "e72e6ddd-63f4-40a3-b820-a32300e14c31"
    }
]

...

Delete all the attachments from the object
Deck of Cards
idbimDeleteObjHyperlink
Card
labelHTTP Method
 DELETE
Card
defaulttrue
labelURL / Resource / JSON Structure
 Resource: objects/<object_id>/att 

URL: https://api-stage.bimplus.net/v2/<team_slug>/objects/<object_id>/attachments

Example: https://api-stage.bimplus.net/v2/bimplus/objects/7cf910cb-e357-43f6-aa3a-b45c26380f75/attachments

Card
labelDescription
 Delete all the attachments from a specified object.
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 200 OK

Anchor
deleteObject
deleteObject

...