Versions Compared

Key

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

...

NameTypeDescription
idguidAttachment Id
relatedIdguidID of the object/project/issue the attachment is attached to.
namestringAttachment name
fileNamestringName of the attachment's file
typestringAttachment's content type
sizeintFile size in bytes
sizeMBintFIle size in megabytes
createAtstring ( Date )Date of creation
creatorjson ( User )User who created the attachment
changedstring ( Date )Date of last modification
changedByjson ( User )User who did the modification
attachmentTypestringBimplus attachment type. Default type is "Document"
hashstringFile hash
classificationstringBimplus internal attachment classification.
tagstringOptional value, for additional marking of the attachment.
objectIdsarray of guidObsolete. Replaced by "relatedId"
versionintAttachment version
rightsjsonUser's right to the attachment, has following boolean properties : update, share, delete, download
releasestring(bool)True if attachment is share or false if attachment is not share.


Deck of Cards
idbimcreateAttachment


Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: attachments/<attachment_id>/download 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/attachments/<attachment_id>/download OR https://api-stage.bimplus.net/v2/<team_slug>/attachments/<attachment_id>/download?api-token=token (If the client cannot use the token in the header request)

Examplehttps://api-stage.bimplus.net/v2/bimplus/attachments/d0b3fc78-8f60-4e3f-ae72-65beb3dcb7d2/download OR https://api-stage.bimplus.net/v2/bimplus/attachments/d0b3fc78-8f60-4e3f-ae72-65beb3dcb7d2/download?api-token=9c1874a62c974dcfa75e0132c423a088


Card
labelHTTP Method
 GET


Card
labelDescription

Download the content of a specified attachment.

There is a support to download the list of all attachments for selection object (if selection type is 'Elements' and defined elements are attachments) or the list of all attachments for structure node (for type of structure 'Document Folder'). In this case (attachments/<selection_id>/download or attachments/<structure_id>/download) the downloaded content is a compressed zip file including these attachments. If there is not any attachment for selection/structure the return code is 404 Not Found. If Selection\Document Folder structure contains files with same names, the return code is 403 Forbidden.

The token can be also provided as the query string for downloading the attachment(If the client cannot use the token in the header request).


Card
labelRequest


Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json



Card
labelResponse


Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK

The response format is application/octet-stream.




Anchor
getAttachmentInfo
getAttachmentInfo

...