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 Cardstab-group

iddeckId	bimcreateAttachment

Cardtab

default	true
labeltitle	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

Cardtab

labeltitle	HTTP Method

POST

Cardtab

labeltitle	Description

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

Cardtab

labeltitle	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...
}

Cardtab

labeltitle	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

The response format is application/octet-stream.

...

Get Attachment information

Deck of Cardstab-group

iddeckId	bimGetAttachmentInfo

Cardtab

default	true
labeltitle	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/d0b3fc78-8f60-4e3f-ae72-65beb3dcb7d2

Cardtab

labeltitle	HTTP Method

GET

Cardtab

labeltitle	Description

Get detailed information about a specified attachment.

Cardtab

labeltitle	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Cardtab

labeltitle	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

{
     "objectIds": [
         "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
     ],
     "fileName": "Building_Plan.jpg",
     "type": "image/jpeg",
     "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" : "",
     "tag" : "",
     "sizeMB" : "0,21",
     "version" : "1",
     "relatedId" : "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
     "rights" : {
         "update" : true,
         "share" : true,
         "delete" : true,
         "download" : true
     }
     "id": "6cea110a-88f4-43ac-9a00-ebaf677be333"
}

Anchor

	downloadAttachment
	downloadAttachment

Download the attachment

Deck of Cardstab-group

iddeckId	bimDownloadAttachment

Cardtab

default	true
labeltitle	URL / Resource / JSON Structure

Resource: attachments/<attachment_id>/download

URL: https://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)

Example: https://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

Cardtab

labeltitle	HTTP Method

GET

Cardtab

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

Cardtab

labeltitle	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Cardtab

labeltitle	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

The response format is application/octet-stream.

Anchor

	updateAttachment
	updateAttachment

Update the attachment

Deck of Cardstab-group

iddeckId	bimUpdateAttachment

Cardtab

default	true
labeltitle	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

Cardtab

labeltitle	HTTP Method

PUT

Cardtab

labeltitle	Description

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

Cardtab

labeltitle	Request

Bimplus supports creating and updating of attachments 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"

Cardtab

labeltitle	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"
}

Anchor

	deleteAttachment
	deleteAttachment

Delete the Attachment

Deck of Cardstab-group

iddeckId	bimDeleteAttachment

Cardtab

default	true
labeltitle	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/d0b3fc78-8f60-4e3f-ae72-65beb3dcb7d2

Cardtab

labeltitle	HTTP Method

DELETE

Cardtab

labeltitle	Description

Deletes a specified attachment.

Cardtab

labeltitle	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Cardtab

labeltitle	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

...

Create a new version of an attachment

Deck of Cardstab-group

iddeckId	bimCreateVersion

Cardtab

default	true
labeltitle	URL / Resource / JSON Structure

Resource: attachments/<attachment_id>/versions

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

Example: https://api-stage.bimplus.net/v2/bimplus/attachments/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e/versions

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. The request Content-Type is multipart/form-data

Cardtab

labeltitle	HTTP Method

POST

Cardtab

labeltitle	Description

Create a new version of an attachment. The request headers and content are identical with that of update attachment ( see above ).

Cardtab

labeltitle	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Cardtab

labeltitle	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

borderColor	Red
lang	xml
title	JSON

   {
        "objectIds": [
            "00000000-0000-0000-0000-000000000000"
        ],
        "fileName": "CommentDTO.png",
        "type": "image/png",
        "size": 19565,
        "createdAt": "2014-02-18T14:26:26",
        "creator": {
            "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "jayaraj.purushothaman@gmail.com",
            "status": "Active",
            "firstname": "Jayaraj",
            "lastname": "Purushothaman",
            "company": "Jay Company",
            "fullname": "Jayaraj Purushothaman",
            "displayname": "Jayaraj Purushothaman [Jay Company]",
            "info": null,
            "gender": "MR",
            "phoneWork": null,
            "phoneHome": null,
            "fax": null,
            "mobile": "",
            "birthDate": null,
            "address": {
                "street": "",
                "streetNr": "",
                "zip": "",
                "city": "",
                "country": ""
            },
            "preferedLanguage": "en"
        },
        "changed": "2014-02-18T14:26:26",
        "changedBy": {
            "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "jayaraj.purushothaman@gmail.com"
        },
        "hash": "8ca75220-5580-4413-b29f-0e93267a6524",
        "classification": "",
        "tag": "",
        "sizeMB": "0,02",
        "version": 1,
        "id": "f40a22a0-5c53-4d1b-8e93-e1556514828d"
    }

...

Get all the versions of an attachment

Deck of Cardstab-group

iddeckId	bimGetAllVersions

Cardtab

default	true
labeltitle	URL / Resource / JSON Structure

Resource: attachments/<attachment_id>/versions

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

Example: https://api-stage.bimplus.net/v2/bimplus/attachments/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e/versions

Cardtab

labeltitle	HTTP Method

GET

Cardtab

labeltitle	Description

Get all the version of an attachment

Cardtab

labeltitle	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Cardtab

labeltitle	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

    [
    {
        "objectIds": [
            "9022417d-261f-4dfa-83d3-66405232722f"
        ],
        "fileName": "CommentDTO.png",
        "type": "image/png",
        "size": 107633,
        "createdAt": "2014-02-18T14:26:26",
        "creator": {
            "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "jayaraj.purushothaman@gmail.com",
            "status": "Active",
            "firstname": "Jayaraj",
            "lastname": "Purushothaman",
            "company": "Jay Company",
            "fullname": "Jayaraj Purushothaman",
            "displayname": "Jayaraj Purushothaman [Jay Company]",
            "info": null,
            "gender": "MR",
            "phoneWork": null,
            "phoneHome": null,
            "fax": null,
            "mobile": "",
            "birthDate": null,
            "address": {
                "street": "",
                "streetNr": "",
                "zip": "",
                "city": "",
                "country": ""
            },
            "preferedLanguage": "en"
        },
        "changed": "2015-11-18T10:16:32.233",
        "changedBy": {
            "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "jayaraj.purushothaman@gmail.com"
        },
        "hash": "59c2b69d-fb99-4b62-8c2b-5f3c7531ffb2",
        "attachmentType": "NonModel",
        "classification": "",
        "tag": "",
        "sizeMB": "0,1",
        "version": 2,
        "id": "f40a22a0-5c53-4d1b-8e93-e1556514828d"
    },
    {
        "objectIds": [
            "00000000-0000-0000-0000-000000000000"
        ],
        "fileName": "CommentDTO.png",
        "type": "image/png",
        "size": 19565,
        "createdAt": "2014-02-18T14:26:26",
        "creator": {
            "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "jayaraj.purushothaman@gmail.com",
            "status": "Active",
            "firstname": "Jayaraj",
            "lastname": "Purushothaman",
            "company": "Jay Company",
            "fullname": "Jayaraj Purushothaman",
            "displayname": "Jayaraj Purushothaman [Jay Company]",
            "info": null,
            "gender": "MR",
            "phoneWork": null,
            "phoneHome": null,
            "fax": null,
            "mobile": "",
            "birthDate": null,
            "address": {
                "street": "",
                "streetNr": "",
                "zip": "",
                "city": "",
                "country": ""
            },
            "preferedLanguage": "en"
        },
        "changed": "2014-02-18T14:26:26",
        "changedBy": {
            "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "jayaraj.purushothaman@gmail.com"
        },
        "hash": "8ca75220-5580-4413-b29f-0e93267a6524",
        "classification": "",
        "tag": "",
        "sizeMB": "0,02",
        "version": 1,
        "id": "f40a22a0-5c53-4d1b-8e93-e1556514828d"
    }
]

Anchor

	releaseAttachment
	releaseAttachment

Share the attachment

Deck of Cardstab-group

iddeckId	bimShareDocument

Cardtab

default	true
labeltitle	URL / Resource / JSON Structure

Resource: attachments/<attachment_id>/release

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

Example: https://api-stage.bimplus.net/v2/bimplus/attachments/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e/release

Cardtab

labeltitle	HTTP Method

PUT

Cardtab

labeltitle	Description

Share the least version of projects attachment. Where attachemnt_id can by attachment, folder or selection.

Cardtab

labeltitle	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Cardtab

labeltitle	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

    {
	"id": "a9e2428d-c67c-4a56-9aeb-880a5dbfa6b3",
	"objectIds": ["00000000-0000-0000-0000-000000000000"],
	"fileName": "_.,_.,_,._.,_.,.ifc",
	"type": "application/octet-stream",
	"size": 6729,
	"createdAt": null,
	"creator": null,
	"hash": "",
	"attachmentType": "Document",
	"classification": "",
	"tag": "",
	"sizeMB": "0,01",
	"version": 1,
	"relatedId": "00000000-0000-0000-0000-000000000000",
	"release": true,
	"sharedDate": "2021-02-12T14:01:17.067456+01:00",
	"sharedBy": {
		"id": "efeb4da2-1c7c-4aa8-ab13-28638f9669a8",
		"email": "nemetschek@allplan.com",
		"firstname": "nem",
		"lastname": "tschek",
		"company": null,
		"fullname": "nemetschek",
		"displayname": "nemetschek",
		"shortdisplayname": "nemetschek"
	}
}

...

Download a particular version of the attachment

Deck of Cardstab-group

iddeckId	bimDownloadAttachment

Cardtab

default	true
labeltitle	URL / Resource / JSON Structure

Resource: attachments/<attachment_id>/versions/<version_no>/download

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

Example: https://api-stage.bimplus.net/v2/bimplus/attachments/d0b3fc78-8f60-4e3f-ae72-65beb3dcb7d2/versions/1/download OR https://api-stage.bimplus.net/v2/bimplus/attachments/d0b3fc78-8f60-4e3f-ae72-65beb3dcb7d2/versions/<version_no>/download?api-token=9c1874a62c974dcfa75e0132c423a088

Cardtab

labeltitle	HTTP Method

GET

Cardtab

labeltitle	Description

Download a particular version of the attachment

Cardtab

labeltitle	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Cardtab

labeltitle	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

The response format is application/octet-stream.

...

Delete a particular version

Deck of Cardstab-group

iddeckId	bimDeleteAttachment

Cardtab

default	true
labeltitle	URL / Resource / JSON Structure

Resource: attachments/<attachment_id>/versions/<version_no>

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

Example: https://api-stage.bimplus.net/v2/bimplus/attachments/d0b3fc78-8f60-4e3f-ae72-65beb3dcb7d2/versions/1

Cardtab

labeltitle	HTTP Method

DELETE

Cardtab

labeltitle	Description

Delete a particular version of the attachment

Cardtab

labeltitle	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Cardtab

labeltitle	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

...

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 43

New Version Current

Key

Create the attachment

Get Attachment information

Download the attachment

Update the attachment

Delete the Attachment

Create a new version of an attachment

Get all the versions of an attachment

Share the attachment

Download a particular version of the attachment

Delete a particular version