Page History

...

Deck of Cards

id	bimObjCreateAttachment

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects/<object_id>attachments

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

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

JSON Structure: Please note that all the information required for this call will be taken from the document that you attach and hence the request of this call has no body.

Name	Mandatory / Optional	Type	Description
objectIds	will be ignored	string	The id of the project objects to which the file has to be attached
fileName	will be ignored	string	Name of the file to be attached to the project
type	will be ignored	string	Mime type
size	will be ignored	integer	Size of the file to be attached to the project
createdAt	will be ignored	string	Creation date of the attachment
creator	will be ignored	object	The user who created the attachment

Card

label	HTTP Method

POST

Card

label	Description

Create a new attachment in a object.

Card

label	Request

Bimplus supports creating and updating of attachments only using requests with multipart/form-data content type. 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: 201 Created

Code Block

borderColor	Red
lang	xml
title	JSON

    {
        "objectIds": [
            "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
        ],
        "fileName": "Building_PlanTestFile.jpgxml",
        "type": "imageapplication/jpegxml",
        "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",
     },
     "infochanged" : "2013-12-11T10:47:39",
        "genderchangedBy" : "",{
         "phoneWorkid": "e18941f4-a809-2d01-d27d-cd251f2b6cb6",
         "phoneHomeemail": "test@bimplus.net",
     },
     "faxhash": "68a59c1f-1914-43b8-92fc-1cee4ad1c90c",
        "mobileattachmentType" : "Document",
        "birthDateclassification" : "0000-00-00Report",
     "tag" :  "addressABCDE": {,
     "sizeMB" : "0,21",
     "streetversion" : "Westermeier str.1",
     "relatedId" : "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
     "streetNrrights" : "10",
  {
          "zipupdate" : "81829"true,
            "cityshare" : "München"true,
            "countrydelete" : "Germany"
        },
true,
         "preferedLanguagedownload" : "en"true
       },
        "id": "6cea110a-88f4-43ac-9a00-ebaf677be333"
    }

Anchor

	objGetAttachment
	objGetAttachment

...

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 20

New Version 21

Key