4.8 Attachment Service

Attachment Service

Create the attachment
Get attachment information
Download the attachment
Update the attachment
Delete the attachment
Filter for getting project-only attachments & attachments that belong to a particular attachment-type
Create a new version of an attachment
Get all the versions of an attachment
Share the attachment
Download a particular version
Delete a particular version

Attachment Service

Attachments are mostly documents or any media files with additional information which can be assigned to any project, object, issue or slide. Please see the detailed structure of the attachment in the Object Model

Please use the Bimplus Project Service for creating an attachment or for getting/deleting all the attachments of a project
Please use the Bimplus Object Service for creating an attachment or for getting/deleting all the attachments of an object, issue or slide

Attachment Json

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

The body of string format

Name	Mandatory/Optional	Type	Description
fileName	optional	string	Name of the attachment
imageData	mandatory	string	data for image

The responses of json in following format :

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

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

POST

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

Headers

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

JSON

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

Status

Status: 201 Created

The response format is application/octet-stream.

Get Attachment information

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

GET

Get detailed information about a specified attachment.

Headers

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

Status

Status: 200 OK

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

Download the attachment

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

GET

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

Headers

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

Status

Status: 200 OK

The response format is application/octet-stream.

Update the attachment

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

PUT

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

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 :

Headers

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

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"

Status

Status: 200 OK

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

Delete the Attachment

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

DELETE

Deletes a specified attachment.

Headers

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

Status

Status: 200 OK

Filter for getting project-only attachments & attachments that belong to a particular attachment-type

The normal attachment GET call (i.e projects/<project_id>/attachments) returns all the attachments inside a project i.e it iterates through all the objects inside a project and returns everything. If we want to retrieve the only the attachments that belongs to the project directly, then use ?projectOnly=true filter (i.e projects/<project_id>/attachments?projectOnly=true)
Bimplus recognized following types of attachments : Document, Thumbnail, Ifc, SketchUp, AllplanResource, AllplanDrawing, AllplanLayout, AllplanLayoutDocument, AutodeskResource, Revit, AutoCadDrawing, BcfZip.
Of those, the type "Document" is handled as public and visible to all applications. The rest are either Bimplus internal, or application specific attachment types, visible only to the particular applications ( e.g. all "Allplan..." types are used by Allplan only ).
If the type is not specified, the default type "Document' is used.
The normal attachment GET call (i.e projects/<project_id>/attachments) returns by default only the attachments of type "Document". If you want to retrieve the attachments that belongs to particular attachment type, then specify the type in the filter ?attachmentType=<requested_type> (eg: projects/<project_id>/attachments?attachmentType=Ifc&attachmentType=SketchUp).

Create a new version of an attachment

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

POST

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

Headers

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

Status

Status: 201 Created

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

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

GET

Get all the version of an attachment

Headers

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

Status

Status: 200 OK

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

Share the attachment

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

PUT

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

Headers

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

Status

Status: 200 OK

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

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

GET

Download a particular version of the attachment

Headers

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

Status

Status: 200 OK

The response format is application/octet-stream.

Delete a particular version

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

DELETE

Delete a particular version of the attachment

Headers

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

Status

Status: 200 OK

Math Editor

Space shortcuts

Page tree

Attachment Service

Attachment Service

Create the attachment

Get Attachment information

Download the attachment

Update the attachment

Delete the Attachment

Filter for getting project-only attachments & attachments that belong to a particular attachment-type

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