Page History

...

Deck of Cards

id	bimCreateAttachmentForIssue

Card

default	true
label	URL / Resource / JSON Structure

Resource: issues/<issue_id>/attachments

URL: https://api-stage.bimplus.net/v2//issues/<issue_id>/attachments

Example:https://api-stage.bimplus.net/v2/bimplus/issues/8ead8bfe-ab23-4340-ac47-38181e83bff3/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

Creates a new attachment for a specified issue.

Card

label	HTTP Method

POST

Card

label	Description

Creates a new attachment for a specified issue.

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

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

; boundary=----MyFormBoundarytlTJWL8i2mvYwGPW

xml

Code Block

borderColor

Green

lang

title	Status

Status: 201 Created

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": [

Code Block

borderColor	Red
lang	xml
title	JSON

    {
        "objectIds": [
            "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
        ],
        "fileName": "Building_Plan.jpg",
        "type": "image/jpeg",
        "size": 211258,
        "createdAt": " "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",
     },
     "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

	getAttachmentsFromIssue
	getAttachmentsFromIssue

...

Deck of Cards

id	bimGetAttachmentListFromIssue

Card

default	true
label	URL / Resource / JSON Structure

Resource: issues/<issue_id>/attachments

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

Example: https://api-stage.bimplus.net/v2/bimplus/issues/8ead8bfe-ab23-4340-ac47-38181e83bff3/attachments

Card

label	HTTP Method

GET

Card

label	Description

Gets the attachment list from a specified issue.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	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_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,
            "city""share" : "München"true,
            "countrydelete" : "Germany"true,
        },
        "preferedLanguagedownload" : "en"true
       },
        "id": "6cea110a-88f4-43ac-9a00-ebaf677be333"
  },
  }...
]

Anchor

	deleteAttachmentsFromIssue
	deleteAttachmentsFromIssue

...

Deck of Cards

id	bimDeleteAttachmentFromIssue

Card

default	true
label	URL / Resource / JSON Structure

Resource: issues/<issue_id>/attachments

URL: https://api-stage.bimplus.net/v2//issues/<issue_id>/attachments

Example:https://api-stage.bimplus.net/v2/bimplus/issues/8ead8bfe-ab23-4340-ac47-38181e83bff3/attachments

Card

label	HTTP Method

DELETE

Card

label	Description

Delete all the attachments from a specified issue.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

...

Status: 200 OK

Deck of Cards

id	bimDeleteIssue

Card

default	true
label	URL / Resource / JSON Structure

Resource: issues/<issue_id>

URL: https://api-stage.bimplus.net/v2/<team_slug>/issues/<issue_id>

Example: https://api-stage.bimplus.net/v2/bimplus/issues/8ead8bfe-ab23-4340-ac47-38181e83bff3

Card

label	HTTP Method

DELETE

Card

label	Description

Deletes a specified issue.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

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 :

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"

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 10

New Version 11

Key