Versions Compared

Key

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

...

Deck of Cards
idbimCreateAttachmentInProject
Card
labelImplementation Status

 Service available !

Card
labelHTTP Method

POST

Card
defaulttrue
labelURL / Resource / JSON Structure

Resource: projects/<project_id>/attachments 

URLhttps://api.bimplus.net/v2/<team>/projects/<project_id>/attachments

Examplehttps://api.bimplus.net/v2/bimplus/projects/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e/attachments

JSON Structure

Name

Mandatory / Optional

Type

Description

objectIds

optional

string

The id of the project objects to which the file has to be attached

fileName

optional

string

Name of the file to be attached to the project

type

optional

string

Mime type

size

optional

integer

Size of the file to be attached to the project

Card
labelDescription

Creates a new attachment in a project.

Card
labelRequest
Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: applicationmultipart/jsonform-data
Code Block
borderColorRed
langxml
titleJSON
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
Status: 201 Created


Code Block
borderColorRed
langxml
titleJSON

[
    {
        "objectIds": [
            "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
        ],
        "fileName": "Building_Plan.jpg",
        "type": "image/jpeg",
        "size": 211258,
        "id": "6cea110a-88f4-43ac-9a00-ebaf677be333"
    }
]


Anchor
getAttachments
getAttachments

...

Deck of Cards
idbimGetAttachmentListFromProject
Card
labelImplementation Status

 Service available !

Card
labelHTTP Method

GET

Card
defaulttrue
labelURL / Resource / JSON Structure

Resource: projects/<project_id>/attachments 

URLhttps://api.bimplus.net/v2/<team>/projects/<project_id>/attachments

Examplehttps://api.bimplus.net/v2/bimplus/projects/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e/attachments

Card
labelDescription

Get all the attachments belonging to a specified project.

Card
labelRequest
Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK


Code Block
borderColorRed
langxml
titleJSON

[
    {
        "objectIds": [
            "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
        ],
        "fileName": "Building_Plan.jpg",
        "type": "image/jpeg",
        "size": 211258,
        "id": "6cea110a-88f4-43ac-9a00-ebaf677be333"
    }
]


Anchor
deleteAttachments
deleteAttachments

...

Deck of Cards
idbimObjCreateAttachment
Card
labelImplementation Status

 Service available !

Card
labelHTTP Method

POST

Card
defaulttrue
labelURL / Resource / JSON Structure

Resource: objects/<object_id>attachments 

URLhttps://api.bimplus.net/v2/<team>/objects/<object_id>attachments

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

JSON Structure

Name

Mandatory / Optional

Type

Description

objectIds

optional

string

The id of the objects to which the file has to be attached

fileName

optional

string

Name of the file to be attached to the project

type

optional

string

Mime type

size

optional

integer

Size of the file to be attached to the project

Card
labelDescription

Create a new attachment in a object.

Card
labelRequest
Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: applicationmultipart/jsonform-data


Code Block
borderColorRed
langxml
titleJSON
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
Status: 201 Created


Code Block
borderColorRed
langxml
titleJSON

...

Deck of Cards
idbimCreateAttachmentForIssue
Card
labelImplementation Status

 Service available !

Card
labelHTTP Method

POST

Card
defaulttrue
labelURL / Resource / JSON Structure

Resource: issues/<issue_id>/attachments 

URLhttps://api.bimplus.net/v2/<team>/issues/<issue_id>/attachments

Example:

JSON Structure

Name

Mandatory / Optional

Type

Description

objectIds

optional

string

The id of the issue objects to which the file has to be attached

fileName

optional

string

Name of the file to be attached to the project

type

optional

string

Mime type

size

optional

integer

Size of the file to be attached to the project

Card
labelDescription

Creates a new attachment for a specified issue.

Card
labelRequest
Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: applicationmultipart/jsonform-data


Code Block
borderColorRed
langxml
titleJSON
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
Status: 201 Created


Code Block
borderColorRed
langxml
titleJSON

...