Versions Compared

Old Version 32

changes.mady.by.user Stanislav Slacky

Saved on

compared with

New Version 33

changes.mady.by.user Stanislav Slacky

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Deck of Cards
idbimCreateAttachmentInProject
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: projects/<project_id>/attachments 

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

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

Card
labelHTTP Method
 POST
Card
labelDescription
 Creates a new attachment in a project.
Card
labelRequest

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
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: multipart/form-data; boundary=----MyFormBoundarytlTJWL8i2mvYwGPW
Code Block
titleContent
------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
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
Status: 201 Created
Code Block
borderColorRed
langxml
titleJSON
{

     "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",
     "relatedId" : "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
     "rights" : {
         "update" : true,
         "share" : true,
         "delete" : true,
         "download" : true
     },
     "id": "6cea110a-88f4-43ac-9a00-ebaf677be333"
}

...

Deck of Cards
idbimGetAttachmentListFromProject
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: projects/<project_id>/attachments 

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

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

Card
labelHTTP Method
 GET
Card
labelDescription
 Get all the attachments belonging to a specified project. 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)
Card
labelRequest
Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK
Code Block
borderColorRed
langxml
titleJSON
[    { 
   {

     "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",
            "streetNr""relatedId" : "100d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
            "zip": "81829","rights" : {
            "cityupdate" : "München"true,
            "countryshare" : "Germany"true,
        } "delete" : true,
         "preferedLanguagedownload" : "en"true
       },
        "id": "6cea110a-88f4-43ac-9a00-ebaf677be333"
  },
  }...
]

Anchor
deleteAttachments
deleteAttachments

...

Deck of Cards
idbimCreateThumbnail
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: projects/<project_id>/thumbnail

URL: https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/thumbnail

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

Card
labelHTTP Method
 POST
Card
labelDescription
 Creates or uploads a thumbnail to the project.
code

Thumbnail API call:

Image Removed

Card
labelRequest
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: multipart/form-data

Headers and content are the same as for Create attachment

Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
Status: 201 Created
Code Block
borderColorRed
langxml
titleJSON
{
  fileName: "MyThumbnail.jpg"
  type: "image/jpeg"
  size: 5262
  id: "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
}

...

Deck of Cards
idbimDownloadThumbnailOfProject
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: thumbnail/<thumbnail_id>

URL: https://api-stage.bimplus.net/v2/<team_slug>/thumbnail/<thumbnail_id>

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

Card
labelHTTP Method
 GET
Card
labelDescription
 Downloads the thumbnail.
Card
labelRequest
Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: multipart/form-data
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK

Response content type is the same as is the "type" of the thumbnail, e.g. "image/jpeg"

Anchor
getStructureList
getStructureList

...