Page History

...

Deck of Cards

id	bimGetPinDetails

Card

label	HTTP Method

GET

Card

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: pins/<pin_id>

URL: https://api.bimplus.net/v2//pins/

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

Card

label	Description

...

Get details of a specified pin.

...

card

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "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"
}

Deck of Cards

Anchor

	updatePin
	updatePin

Update the pin

Deck of Cards

id	bimPinUpdate

Card

label	HTTP Method

PUT

Card

Card

default	true
label	URL / Resource / JSON Structure

Resource: pins/<pin_id>

URL: https://api.bimplus.net/v2//pins/

Example: https://api.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	The creation date

...

Card

label	Description

Update or replace a specified existing pin with a new one.

Card

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "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
    }
}

Card

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Card

Deck of Cards

Anchor

	deletePin
	deletePin

Delete the pin

Deck of Cards

id	bimGetPinDetails

Card

label	HTTP Method

DELETE

Card

default	true
label	URL / Resource / JSON Structure

Resource: pins/<pin_id>

URL: https://api.bimplus.net/v2//pins/

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

Card

Card

label	Description

...

Deletes a specified pin.

...

cardcard

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Deck of Cards

Anchor

	importService
	importService

...

This service is used for creating a new project by importing the existing projects in the form of IFC and SketchUp files into a team base.

Anchor

	createProjectFromIFC
	createProjectFromIFC

Create a new project by importing SketchUp and IFC files

Deck of Cards

id	bimCreateProjectFromIFC

Card

label	HTTP Method

...

POST

Card

Card

default	true
label	URL / Resource / JSON Structure

Resource: import

URL: https://api.bimplus.net/v2/<team_slug>/import

Example: https://api.bimplus.net/v2/bimplus/import

...

Card

label	Description

...

Card

Create a new project by importing SketchUp and IFC files into the team database.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 201 Created

Card

Deck of Cards

Anchor

	createSubProjectFromIFC
	createSubProjectFromIFC

Create a new sub-project by importing SketchUp and IFC files (Not implemented)

Deck of Cards

id	bimCreateSubProjectFromIFC

Card

label	HTTP Method

POST

Card

Card

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects/<project_id>/import

URL: https://api.bimplus.net/v2/<team_slug>/projects/<project_id>/import

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

Card

label	Description

...

Create a new sub-project by importing SketchUp and IFC files into the project.

...

carddeck

Card

label	Request

Card

label	Response

Card

Anchor

	authorizationService
	authorizationService

...

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 248

New Version 249

Key

Update the pin

Delete the pin

Create a new project by importing SketchUp and IFC files

Create a new sub-project by importing SketchUp and IFC files (Not implemented)