Page History

...

Name	Type	Description
id	guid	Attachment Id
relatedId	guid	ID of the object/project/issue the attachment is attached to.
name	string	Attachment name
fileName	string	Name of the attachment's file
type	string	Attachment's content type
size	int	File size in bytes
sizeMB	int	FIle size in megabytes
createAt	string ( Date )	Date of creation
creator	json ( User )	User who created the attachment
changed	string ( Date )	Date of last modification
changedBy	json ( User )	User who did the modification
attachmentType	string	Bimplus attachment type. Default type is "Document"
hash	string	File hash
classification	string	Bimplus internal attachment classification.
tag	string	Optional value, for additional marking of the attachment.
objectIds	array of guid	Obsolete. Replaced by "relatedId"
version	int	Attachment version
rights	json	User's right to the attachment, has following boolean properties : update, share, delete, download
release	string(bool)	True if attachment is share or false if attachment is not share.

Create the attachment

Deck of Cards

id	bimcreateAttachment

Card

default	true
label	URL / Resource / JSON Structure

Resource: attachmentsobjects/<attachment<objects_id>/download attachments

URL: https://api-stage.bimplus.net/v2/<team_slug>/attachmentsobjects/<attachment<objects_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)

Example: https://api-stage.bimplus.net/v2/bimplus/attachmentsobjects/d0b3fc78c411c33-8f608547-4e3f6587-ae72-65beb3dcb7d2/download OR https://api-stage.bimplus.net/v2/bimplus/attachments/d0b3fc78-8f60-4e3f-ae72-65beb3dcb7d2/download?api-token=9c1874a62c974dcfa75e0132c423a088eaf8-1a3a822def5/attachments

Card

label	HTTP Method

GET POST

Card

label	Description

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).

Create of attachments is using of calls with "multipart/form-data" content or by string.

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

Card

label	Request

{

"fileName": "imageName",

"imageData": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAALQAAABwCAYAAAC3tFqQAAAAAXNSR0IArs4c6QAAB4ZJREFUeF7tnVtsFFUcxs8/JvoCD

zwR2hSFLd1CywMgT1Rf1EQTDb4oKJIYjRQEIyZICQoxgAYDeE20BTVqRFBAjbSaCBQVjQqWS/Y6uzvb7YXeC4it9l5ztgFb6GV22p3O+Z9vkqZJO3Nmvu/79dt/tjMt7axo7BfY4AATB+j1

swCaSZaQIYSgXeea0NBAgY0DtBtAswkTQoSgPQAaHDBygN4834yRg1Ggukuhty+0AGjdKWCkn94B0IzihBR6F0CDAkYO0Hu+VowcjALVXQq9D6B1Z4CVfioG0KwC1V0M7fVfwsihOwWM9NO+AI

BmlKf2UuhDAK09BJwMoI8ANKc8tddCHwcvY4bWHgM+BtAnAJpPmlAi6NMQGhoc8HGA9oevYOTgk6f2Suhz4y8ArT0GfAygAwCaT5pQIugggAYGjBygQ5GrGDkYBaq7FDoMoHVngJV+OhJFQ7NKVHMx9HXsb4w

cmkPAST59YwJoToHqroW+BdC6M8BKPx012zBysIpUbzFUFgfQeiPASz19B6B5Jaq5Gvq+sh0jh+YQcJJPPyQANKdAdddCxxL/oKF1p4CRfjpeBaAZ5am9FCoH0NpDwMkA+rH6X4wcnBLVXAv9BKA1R4CXfPq5Ru2GbkhEk4k0

VEYGPieioqenR5iB8+NOqqur6/oaWXPm3bReVk7eTV+baXG/cV8cFhjWAfqltkOpkaO+MiLOnSxLgjvS1tHRITo7O8cd+WCgx72YECIjI0MUPPiomLVgie3lamMh28fKA/v6+pLHzxzmh3FcC7vkYPpVMaDPnixLAj3a5magMzM

zxcIHlotpM2baQuCtF1ZehzLVBXp7e4X8GG4bDnD5aiN/AFXa6LeLajV0RXmZkFCrDHQX3SqmzcgSU6ZMEVnZc1OC+4316QF6JD83Fx9SiWdBv1/sVGrkqCgvFRWKA22apmhra0sC7fF4hGfBEuFZWGAJnD3rn0hLQ4908peK

D1u6LrfsRKfrupQC+s/yUiE/nGjo7u5u0d8/cfbIGVqOHDcCnb2wQMgPK9uu51c4CvSWkiNWLss1+9CZOrUa+kwSaGdGDueAXiLmWAR653OP24ZntBl6pEW3lijW0BX1ajX06ROlQkLNqaElzDmLrDX0a+sesw10qj+gd+TkiSc

3bLN9vsk4kM41dE/ca6oDCv44cVRIqDkBLWH2LrrLkns71i63tN9wO6UMtDdPPLVhu+3zTcaBdF4xoGvjEfHVB3tYAe1NAejtDgI9S0WgLygI9BGGQOdabOhtDgP9tGoN7WtUa+SQDX1oH6+Gzl1UIObeaW3keOVZ50YO2dDPvK

jYyBFo6lFqhq6JG+LLvbyAljDPswj01jXLbI+mqc7Qs735YtVGxYAOKgj0F8yAljBbBXqLw0AXqgZ0qFm9hj5YwquhJcx5i62NHC+vdq6hPd58UVikWEMbLb1KjRzVpiEOlOxm9S6HhDl/8d2WRonNhfZvFkp15PDk5os1RTssXZdbdqJ

oS59yQO8v2cUKaAnzfItAbyp8xDY7doBeW/Sq7fNNxoEUUwzoKtMQ3ICWMFsFushBoLNz84VyQJutajW0BPqz4tEbWj6x0t7ePu6CSLXRxjrhSDcn3fvwSjE98/axDk9+f+Mq5xpaAr1uk2INbbaqNUMPAD36DO12oPtvuS15+6jHmyf

ueyg1QDeucm6GHgBasRk6pti7HFVxOXKM/i6H24G+Z+kKMT3DWiPfWNtFDr7Lke2VI4di73LEmtX6TWFVPMIEaHuPYBWtnpjfFGZ7/3/AV76bcW0b/HXZ0KptFGtW6/ZRCfSpY6WiOj7wlPdwm5sb+v6ly8T8xdZuFZ0omOKRYH

Kp2Tk3P7k+UedwyzoUa1IL6MHGSbjldur4wO2k1yCfTKCvNZycjwdvsu2mTp0qpmfYa2a3AOP266BYo1oPyY5lqIS8Oh4VHZ0dQ3aNR1J//F8+4SEfwfJ4hzbbkJflG8Ad6/rw/fQ6QFFmQKfXLqzudgco1qj2X05yu8G4PmcdoGgD/p

yus5bjbOl0gKL1+Av+6TQYazvrAIB21m+cLc0OULQe/9YtzR5jeQcdoEgd/jWyg37jVGl2gCIXryp1P3Sa/cDyijsAoBUPEJc/1AEyaq+goUEFGwfIqL0MoNnECSEUAdCggJEDZNRcQkMzClR3KWRUtwJo3SlgpJ+M6hYAzShQ3aUAaN

0JYKafwlVNaGhmoeosh8IJAK0zANy0UzjRiIbmlqrGeiicaADQGgPATTqFKusBNLdUNdZDoXgdgNYYAG7SATS3RDXXQyGzFg2tOQSc5FMQQHPKU3stFDJr0NDaY8DHAArFADSfOKGEgtEqNDQ4YOMAgGYTJYRIBygYTaChwQIb

ByhgVAJoNnFCCAWMOIAGB2wcANBsooSQ5AwdCJtoaLDAxgEKhGMAmk2cEEL+UBRAgwM2DlAgFAHQbOKEEPIHDQANDtg4QP5AGECziRNCADQYYOUA+QMhNDSrSPUWQz5/EEDrzQAr9eTzBQA0q0j1FgOg9c6fnXry+fxoa

Hax6isIQOubPUvlAJplrPqKAtD6Zs9S+X+I0HYhadtJ/QAAAABJRU5ErkJggg=="

}

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200201 OKCreated

The response format is application/octet-stream.

...

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 35

New Version 36

Key

Create the attachment