Versions Compared

Key

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

...

Deck of Cards
idbimGetAttachmentInfo
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: attachments/<attachment_id> 

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

Examplehttps://api-stage.bimplus.net/v2/bimplus/attachments/d0b3fc78-8f60-4e3f-ae72-65beb3dcb7d2

Card
labelHTTP Method
 GET
Card
labelDescription
 Get detailed information about a specified attachment.
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_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",
        "attachmentType" : "Document",
        "address": {
            "street": "Westermeier str.",
            "streetNr": "10",
            "zip": "81829",
            "city": "München",
            "country": "Germany"
        },
        "preferedLanguage": "en"
       },
        "id": "6cea110a-88f4-43ac-9a00-ebaf677be333"
    }

...

  • 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 The normal attachment GET call (i.e projects/<project_id>/attachments) returns the attachments of all types (i.e including Allplan attachments like AllplanDrawing, AllplanLayout etc.,) If we want to retrieve the attachments that doesn't include Allplan or other CAD based files then use ?attachmentType=NonModel filter (i.e projects/<project_id>/attachments?attachmentType=NonModel) If we ) 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=<filter<requested_type> (eg: projects/<project_id>/attachments?attachmentType=ifc) The pre-defined attachment types are Thumbnail, Ifc, SketchUp, AllplanResource, AllplanDrawing, AllplanLayout, AllplanLayoutDocument, AutodeskResource, Revit, AutoCadDrawingIfc&attachmentType=SketchUp).

Anchor
createVersion
createVersion

...