Skip to end of metadata
Go to start of metadata

Pin Service


Pin Service


Pins are relation between an issue and an object. It defines position of an issue in the 3D space. Please see the detailed structure of the pin in the Object Model

  • Please use the Bimplus Issue Service for creating a pin or for getting/deleting all the pins assigned to an issue
Get details of the pin
     GET
     Get details of a specified pin.
    Headers
    Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
    Content-Type: application/json
    
    Status
    Status: 200 OK
    
    JSON
    {
        "issueId": "8ead8bfe-ab23-4340-ac47-38181e83bff3",
        "objectId": "7cf910cb-e357-43f6-aa3a-b45c26380f75",
        "topologyNodeId": "387fa6cc-b6f9-4470-8c42-c07982aba660",
        "position": {
            "x": 123.45,
            "y": 234.56,
            "z": 345.67
        },
        "normalVector": {
            "x": 0,
            "y": 1,
            "z": 2
        },
        "createdAt": "2013-06-07T10:07:00",
        "id": "8836308d-f09f-4bb7-b6d2-354a2db205a6"
    }
    

    Update the pin
      Resource: pins/<pin_id> 

      URLhttps://api-stage.bimplus.net/v2/<team_slug>/pins/<pin_id>

      Examplehttps://api-stage.bimplus.net/v2/bimplus/pins/8836308d-f09f-4bb7-b6d2-354a2db205a6

      JSON Structure

      Name

      Mandatory / Optional

      Type

      Description

      issueId

      mandatory

      string (guid)

      The id of the issue to which the pin is related

      objectId

      mandatory

      string (guid)

      The id of the object to which the pin is related

      newObjectId

      optional

      string (guid)

      It should be specified when the pin is assigned to another object via update

      topologyNodeId

      optional

      string (guid)

      The id of the topology to which the pin is attached

      position

      optional

      object

      The position of the issue in the building (x,y,z co-ordinates)

      normalVector

      optional

      object

      The direction of the issue in the 3D space (x,y,z co-ordinates)

      createdAt

      will be ignored

      date

      Creation date of the pin

       PUT
      Update or replace a specified existing pin with a new one.
      Headers
      Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
      Content-Type: application/json
      
      JSON
      {
          "issueId": "8ead8bfe-ab23-4340-ac47-38181e83bff3",
          "objectId": "7cf910cb-e357-43f6-aa3a-b45c26380f75",
          "position": {
              "x": 123.45,
              "y": 234.56,
              "z": 345.67
          },
          "normalVector": {
              "x": 0,
              "y": 1,
              "z": 2
          }
      }
      
      Status
      Status: 200 OK
      

      Delete the pin
         DELETE
         Deletes a specified pin.
        Headers
        Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
        Content-Type: application/json
        
        Status
        Status: 200 OK
        
        • No labels