Versions Compared

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 

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

Examplehttps://api-stage.bimplus.net/v2/bimplus/projects/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e/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

optional

string

The id of the objects to which the file has to be attached

fileName

optional

string

Name of the file to be attached to the project

type

optional

string

Mime type

sizeInMB

optional

integer

Size of the file to be attached to the project

createdAtwill be ignoredstringCreation date of the attachment
creatorwill be ignoredobjectThe user who created the attachment
attachmentTypewill be ignoredstring

Type of attachment. It could be one of the following : Thumbnail, Ifc, SketchUp, AllplanResource, AllplanDrawing, AllplanLayout, AllplanLayoutDocument, AutodeskResource, Revit, AutoCadDrawing

Please note that there exists a filter for it. See the filter section

classificationoptionalstringClassify the attachments. The existing classifications are : Plan, Cost, Contract, Drawing , Specification, Report, Image
tagoptionalstringUser defined classification (We will change this to a list later)
Card
labelHTTP Method
 POST
Card
labelDescription
 Creates a new attachment in a project.
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: multipart/form-data

Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 201 Created
Code Block
borderColorRed
titleJSON
langxml
   {
        "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",
        "info": "",
        "gender": "",
        "phoneWork": "",
        "phoneHome": "",
        "fax": "",
        "mobile": "",
        "birthDate": "0000-00-00",
        "address": {
            "street": "Westermeier str.",
            "streetNr": "10",
            "zip": "81829",
            "city": "München",
            "country": "Germany"
        },
        "preferedLanguage": "en"
       },
        "id": "6cea110a-88f4-43ac-9a00-ebaf677be333"
    }

...