Versions Compared

Key

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

...

Deck of Cards
idbimCreatePin


Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: <team_slug>/issues/<issue_id>/pins 

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

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

JSON Structure

Name

Mandatory / Optional

Type

Description

issueId

will be ignored

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

topologyNodeId

will be ignored

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



Card
labelHTTP Method
 POST


Card
labelDescription
 Create a new pin for an issue for relating the issue with its object.


Card
labelRequest


Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json


Code Block
borderColorRed
langxml
titleJSON
{
    "objectId": "7cf910cb-e357-43f6-aa3a-b45c26380f75",
    "position": {
        "x": "123.45",
        "y": "234.56",
        "z": "345.67"
    },
    "normalVector": {
        "x": "0",
        "y": "1",
        "z": "2"
    }
}



Card
labelResponse


Code Block
borderColorGreen
langxml
titleStatus
Status: 201 Created


Code Block
borderColorRed
langxml
titleJSON
{
    "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+00:00",
    "id": "8836308d-f09f-4bb7-b6d2-354a2db205a6"
}



...

Deck of Cards
idbimGetAllPins


Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: <team_slug>/issues/<issue_id>/pins 

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

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


Card
labelHTTP Method
 GET


Card
labelDescription
 Get all the pins of a specified issue type.


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
[
    {
        "issueId": "8ead8bfe-ab23-4340-ac47-38181e83bff3",
        "objectId": "00000000-0000-0000-0000-000000000000",
        "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"
    }
]



...

Deck of Cards
idbimDeleteAllPins


Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: <team_slug>/issues/<issue_id>/pins 

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

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


Card
labelHTTP Method
 DELETE


Card
labelDescription
 Delete all the pins from a specified issue.


Card
labelRequest


Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json



Card
labelResponse


Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK



...