Page History

...

Anchor

	attachmentService
	attachmentService

Attachment Service

...

Get attachment information
Download the attachment
Update the attachment
Delete the attachment
Anchor
getAttachmentInfo
getAttachmentInfo

Get Attachment information

Deck of Cards

id	bimGetAttachmentList

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: attachments/<attachment_id>

URL: https://api.bimplus.net/v2/<team>/attachments/<attachment_id>

Example:

Card

label	Description

Get detailed information about a specified attachment.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

Anchor

	downloadAttachment
	downloadAttachment

Download the attachment

Deck of Cards

id	bimDownloadAttachment

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: attachments/<attachment_id>/download

URL: https://api.bimplus.net/v2/<team>/attachments/<attachment_id>/download

Example:

Card

label	Description

Download the content of a specified attachment.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Anchor

	uploadAttachment
	uploadAttachment

Update the attachment

Deck of Cards

id	bimUpdateAttachment

Card

label	Implementation Status

Service not finished yet !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: attachments/<attachment_id>

URL: https://api.bimplus.net/v2/<team>/attachments/<attachment_id>

Example:

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

label	Description

Update or replace a specified existing attachment with a new one.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Anchor

	deleteAttachment
	deleteAttachment

Delete the Attachment

Deck of Cards

id	bimDeleteAttachment

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: attachments/<attachment_id>

URL: https://api.bimplus.net/v2/<team>/attachments/<attachment_id>

Example:

Card

label	Description

Deletes a specified attachment.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

...

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 39

New Version 40

Key

Attachment Service

Get Attachment information

Download the attachment

Update the attachment

Delete the Attachment