Page History

...

Create and update of attachments is using of calls with "multipart/form-data" content or by stringapplication/json.

The body of string format

...

Deck of Cards

id	bimcreateAttachment

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects/<objects_id>/attachments

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

Example: https://api-stage.bimplus.net/v2/bimplus/objects/c411c33-8547-6587-eaf8-1a3a822def5/attachments

Card

label	HTTP Method

POST

Card

label	Description

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

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json   or multipart/form-data

Code Block

borderColor	Red
lang	xml
title	JSON

{
  "fileName": "imageName",
  "imageData": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAALQAAABwCAYAAAC3tFqQAAAAAXNSR0IArs4c6QAAB4ZJREFUeF7tnVtsFFUcxs8/Jvo
				CDzwR2hSFLd1CywMgT1Rf1EQTDb4oKJIYjRQEIyZICQoxgAYDeE20BTVqRFBAjbSaCBQVjQqWS/Y6uzvb7YXeC4it9l5ztgFb6G...

{

"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	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

The response format is application/octet-stream.

...

Deck of Cards

id	bimUpdateAttachment

Card

default	true
label	URL / Resource / JSON Structure

Resource: attachments/<attachment_id>

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

Example: https://api-stage.bimplus.net/v2/bimplus/attachments/e092b3ae-c022-46fd-aaea-a7b070142235

Card

label	HTTP Method

PUT

Card

label	Description

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

Card

label	Request

Bimplus supports creating and updating of attachments only using requests with multipart/form-data content type or by application/json. By standard, multipart/form-data content consists of several parts, each part containing a file data.

But Bimplus supports only one file sent per call, so only first part of multipart form data content is used, the rest are ignored. The parts are separated by boundaries, each part contains content headers and content data.

Examples :

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: multipart/form-data; boundary=----MyFormBoundarytlTJWL8i2mvYwGPW

Code Block

title	Content

------MyFormBoundarytlTJWL8i2mvYwGPW
Content-Disposition: form-data; name="TestFile"; filename="TestFile.xml"; classification="Report"; tag="ABCDE"
Content-Type: application/xml
 
**** Here are file data  ******
 
------MyFormBoundarytlTJWL8i2mvYwGPW

Where :

name and filename are mandatory saved as attachment's "name" and "filename" properties
classification and tag are optional, and are saved as attachment's properties "tag" and "classification"
Content-Type is mandatory and is saved as attachment's property "type"

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

title	Json

{
     "objectIds": [
         "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
     ],
     "fileName": "TestFile.xml",
     "type": "application/xml",
     "size": 211258,
     "createdAt": "2013-12-11T10:47:39",
     "creator": {
         "id": "e18941f4-a809-2d01-d27d-cd251f2b6cb6",
         "email": "test@bimplus.net",
         "firstname": "First Name",
         "lastname": "Second Name",
         "company": "Best-Company",
         "fullname": "First Name Second Name",
         "displayname": "Best-Company",
     },
     "changed" : "2013-12-11T10:47:39",
     "changedBy" : {
         "id": "e18941f4-a809-2d01-d27d-cd251f2b6cb6",
         "email": "test@bimplus.net",
     },
     "hash": "68a59c1f-1914-43b8-92fc-1cee4ad1c90c",
     "attachmentType" : "Document",
     "classification" : "Report",
     "tag" : "ABCDE",
     "sizeMB" : "0,21",
     "version" : "1",
	 "release": "false"
     "relatedId" : "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
     "rights" : {
         "update" : true,
         "share" : true,
         "delete" : true,
         "download" : true
     }
     "id": "6cea110a-88f4-43ac-9a00-ebaf677be333"
}

...

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 36

New Version Current

Key