Page History

...

Deck of Cards

id	bimCreateProject

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

POST

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects

URL: https://api.bimplus.net/v2/<team>/projects

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

JSON Structure:

Name	Mandatory / Optional	Type	Description
name	optional	string	Name of the project
shortDescr	optional	string	Short description of the project
created	optional	string (date)	Creation date of the project

Card

label	Description

Creates a new project.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Code Block

borderColor	Red
lang	xml
title	JSON

{
"name" : "Your Awesome Building",
"shortDescr" : "Example for creating a project"
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

borderColor	Red
lang	xml
title	JSON

{
"name": "Your Awesome Building",
"shortDescr": "Example for creating a project",
"thumbnail": null,
"created": "2013-06-01T10:05:00",
"changed": null,
"disciplines": null,
"id": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
}

...

Deck of Cards

id	bimUpdateProject

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

PUT

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects/<project_id>

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

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

JSON Structure:

Name	Mandatory / Optional	Type	Description
name	optional	string	Name of the project
shortDescr	optional	string	Short description of the project
created	optional	string (date)	Creation date of the project
changed	optional	string (date)	Changed date of the project

Card

label	Description

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

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Code Block

borderColor	Red
lang	xml
title	JSON

{
"shortDescr" : "Updating the project"
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

...

Deck of Cards

id	bimCreateIssue

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

POST

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects/<project_id>issues

URL: https://api.bimplus.net/v2/<team>/projects/<project_id>/issues

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

JSON Structure:

Name	Mandatory / Optional	Type	Description
projectId	mandatory	string (guid)	Id of the project
name	optional	string	Name of the issue
description	optional	string	Description of the issue
author	optional	string	Author of the issue
status	optional	string	Status of the issue
createdAt	optional	string (date)	Creation date of the issue
dueDate	optional	string (date)	The date in which the issue is planned to be finished
solution	optional
classification	optional	string
priority	optional	string

Card

label	Description

Creates a new issue in a project.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Code Block

borderColor	Red
lang	xml
title	JSON

{
"projectId": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
"name": "Fire Exit Wrong",
"description": "The fire exit is in the wrong place",
"author": "Mr. Smart",
"status": "open",
"createdAt": "2013-06-02T10:05:00",
"dueDate": "2013-06-05T10:05:00",
"classification": "",
"priority": "very high"
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

borderColor	Red
lang	xml
title	JSON

{
    "projectId": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
    "name": "Fire Exit Wrong",
    "description": "The fire exit is in the wrong place",
    "author": "Mr. Smart",
    "status": "open",
    "createdAt": "2013-06-02T10:05:00+00:00",
    "dueDate": "2013-06-05T10:05:00+00:00",
    "solution": null,
    "classification": "",
    "priority": "very high",
    "revision": null,
    "id": "8ead8bfe-ab23-4340-ac47-38181e83bff3"
}

...

Deck of Cards

id	bimGetIssueList

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects/<project_id>issues

URL: https://api.bimplus.net/v2/<team>/projects/<project_id>/issues

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

Card

label	Description

Get all the issues assigned to a specified project.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

...

Delete all the issues from the project

...

Deck of Cards

id	bimDeleteIssueList

Card

label	Implementation Status

Image Added Service available !

Card

label	HTTP Method

DELETE

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects/<project_id>issues

URL: https://api.bimplus.net/v2/<team>/projects/<project_id>/issues

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

{ "projectId": "

0d2ce2cc-3588-45d6-a59a-f6b89ebed34e

", "name": "Fire Exit Wrong", "description": "The fire exit is in the wrong place", "author": "Mr. Smart", "status": "open", "createdAt": "2013-06-02T10:05:00+00:00", "dueDate": "2013-06-05T10:05:00+00:00", "solution": null, "classification": "", "priority": "very high", "revision": null, "id": "8ead8bfe-ab23-4340-ac47-38181e83bff3" }

...

Delete all the issues from the project

...

/issues

Card

label	Description

Delete all the issues belonging to a specified project.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application

Deck of Cards

id	bimDeleteIssueList

Card

label	Implementation Status

Image Removed Service available !

Card

label	HTTP Method

DELETE

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects/<project_id>issues

URL: https://api.bimplus.net/v2/<team>/projects/<project_id>/issues

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

Card

label	Description

Delete all the issues belonging to a specified project.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

...

Deck of Cards

id	bimCreateAttachmentInProject

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

POST

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects/<project_id>/attachments

URL: https://api.bimplus.net/v2/<team>/projects/<project_id>/attachments

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

JSON Structure:

Name	Mandatory / Optional	Type	Description
objectIds	optional	string	The id of the project 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
size	optional	long integer	Size of the file to be attached to the project

Card

label	Description

Creates a new attachment in a project.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Status: 200 OK

Code Block

borderColor	GreenRed
lang	xml
title	Status

JSON

Card

label	Response

Code Block

borderColor	RedGreen
lang	xml
title	JSON	Status


Status: 201 Created

[3] 0: { id: "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e" name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang" }- 1: { id: "2d703abe-b4f9-407c-af53-a39c5b7ba872" name: "__5 999 Parklife Salzburg Lehen" }- 2: { id: "c480cc54-aec4-4bef-8d35-93bb090e1aba" name: "0811-Wohnhaus Kraus - Carport1" }

Code Block

borderColor	Red
lang	xml
title	JSON

Get the Attachment List from the project

Deck of Cards

id	bimGetAttachmentListFromProject

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects/<project_id>/attachments

URL: https://api.bimplus.net/v2/<team>/projects/<project_id>/attachments

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

Card

label	Description

Get all the attachments belonging to a specified project.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

[3] 0: { id: "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e" name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang" }- 1: { id: "2d703abe-b4f9-407c-af53-a39c5b7ba872" name: "__5 999 Parklife Salzburg Lehen" }- 2: { id: "c480cc54-aec4-4bef-8d35-93bb090e1aba" name: "0811-Wohnhaus Kraus - Carport1" }

Code Block

borderColor	Red
lang	xml
title	JSON

Delete all the attachments from the project

Deck of Cards

id	bimDeleteAttachmentListFromProject

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

DELETE

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects/<project_id>/attachments

URL: https://api.bimplus.net/v2/<team>/projects/<project_id>/attachments

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

Card

label	Description

Delete all the attachments belonging to a specified project.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

Get the project topology tree

...

Deck of Cards

id	bimGetObject1

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

POST

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects

URL: https://api.bimplus.net/v2/<team>/objects

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

JSON Structure:

Name	Mandatory / Optional	Type	Description
parent	optional	string (guid)	The id of the parent to which the object can be associated
type	mandatory	string	Element type of the object
attributes	optional	string	Attributes of the object
children	optional	Object	Children of the object

Card

label	Description

Creates a new object

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Code Block

borderColor	Red
lang	xml
title	JSON

{
    "parent": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
    "type": "Wall",
    "attributes": {
        "element": {
            "isparent": true,
            "nr": 0,
            "matrix": "AAAAAAAA8D8AAAAAAAAAgAAAAAAAAACAINejcP1YsEAAAAAAAAAAgAAAAAAAAPA/AAAAAAAAAIAK16Nw/fy2QAAAAAAAAACAAAAAAAAAAIAAAAAAAADwPwAArkfheoS/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8=",
            "elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
            "divisionid": "ac21b9a1-8853-4658-9fbf-0cf62340bd18"
        },
        "general": {
            "name": "Brickwall",
            "isobjectvalid": true
        },
        "quantity": {
            "width": 115
        },
        "allplan": {
            "allplan_guid": "08b8195a-a2ad-11e2-9993-002215ea7d6b",
            "allplan_id": 2065507287,
            "allplan_text": "<PP>Wall",
            "dateofexport": "2013-05-01T09:32:13"
        },
        "geometry": {
            "mesh": "{\"C\":4278255360,\"V\":[4450.01,115.01,0.01,3200.01,115.01,0.01,3200.01,0.01,0.01,4450.01,0.01,0.01,2315.01,0.01,0.01,2315.01,115.01,0.01,0.01,115.01,0.01,0.01,0.01,0.01,4450.01,115.01,2750.01,4450.01,0.01,2750.01,0.01,0.01,2750.01,0.01,115.01,2750.01,2315.01,115.01,2190.01,3200.01,115.01,2190.01,3200.01,0.01,2190.01,2315.01,0.01,2190.01],\"F\":[4,0,1,2,3,4,4,5,6,7,4,8,9,10,11,4,0,3,9,8,8,6,5,12,13,1,0,8,11,4,7,6,11,10,8,3,2,14,15,4,7,10,9,4,12,15,14,13,4,15,12,5,4,4,13,14,2,1]}"
        }
    }
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

borderColor	Red
lang	xml
title	JSON

{
    "id": "7cf910cb-e357-43f6-aa3a-b45c26380f75",
    "parent": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
    "type": "Wall",
    "attributes": {
        "element": {
            "isparent": true,
            "nr": 0,
            "matrix": "AAAAAAAA8D8AAAAAAAAAgAAAAAAAAACAINejcP1YsEAAAAAAAAAAgAAAAAAAAPA/AAAAAAAAAIAK16Nw/fy2QAAAAAAAAACAAAAAAAAAAIAAAAAAAADwPwAArkfheoS/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8=",
            "elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
            "divisionid": "ac21b9a1-8853-4658-9fbf-0cf62340bd18"
        },
        "general": {
            "name": "Brickwall",
            "isobjectvalid": true
        },
        "quantity": {
            "width": 115
        },
        "allplan": {
            "allplan_guid": "08b8195a-a2ad-11e2-9993-002215ea7d6b",
            "allplan_id": 2065507287,
            "allplan_text": "<PP>Wall",
            "dateofexport": "2013-05-01T09:32:13"
        },
        "geometry": {
            "mesh": "{\"C\":4278255360,\"V\":[4450.01,115.01,0.01,3200.01,115.01,0.01,3200.01,0.01,0.01,4450.01,0.01,0.01,2315.01,0.01,0.01,2315.01,115.01,0.01,0.01,115.01,0.01,0.01,0.01,0.01,4450.01,115.01,2750.01,4450.01,0.01,2750.01,0.01,0.01,2750.01,0.01,115.01,2750.01,2315.01,115.01,2190.01,3200.01,115.01,2190.01,3200.01,0.01,2190.01,2315.01,0.01,2190.01],\"F\":[4,0,1,2,3,4,4,5,6,7,4,8,9,10,11,4,0,3,9,8,8,6,5,12,13,1,0,8,11,4,7,6,11,10,8,3,2,14,15,4,7,10,9,4,12,15,14,13,4,15,12,5,4,4,13,14,2,1]}"
        }
    }
}

...

Deck of Cards

id	bimObjectUpdate

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

PUT

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects/<object_id>

URL: https://api.bimplus.net/v2/<team>/objects/<object_id>

Example: https://api.bimplus.net/v2/bimplus/objects/7cf910cb-e357-43f6-aa3a-b45c26380f75

JSON Structure:

Name	Mandatory / Optional	Type	Description
parent	optional	string (guid)	The id of the parent to which the object can be associated
type	mandatory	string	Element type of the object
attributes	optional	string	Attributes of the object
children	optional	object	Children of the object

Card

label	Description

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

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Code Block

borderColor	Red
lang	xml
title	JSON

{
    "parent" : "02dc3da7-600a-494d-9b2b-e72b74143062",
    "type": "Wall",
    "attributes": {
        "element": {
            "isparent": true,
            "nr": 0,
            "matrix": "AAAAAAAA8D8AAAAAAAAAgAAAAAAAAACAINejcP1YsEAAAAAAAAAAgAAAAAAAAPA/AAAAAAAAAIAK16Nw/fy2QAAAAAAAAACAAAAAAAAAAIAAAAAAAADwPwAArkfheoS/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8=",
            "elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
             "divisionid": "ac21b9a1-8853-4658-9fbf-0cf62340bd18"
        },
        "general": {
            "name": "Brickwall",
            "isobjectvalid": true
        },
        "quantity": {
            "width": 115
        },
        "allplan": {
            "allplan_guid": "08b8195a-a2ad-11e2-9993-002215ea7d6b",
            "allplan_id": 2065507287,
            "allplan_text": "<PP>Wall",
            "dateofexport": "2013-05-01T09:32:13"
        },
        "geometry": {
            "mesh": "{\"C\":4278255360,\"V\":[4450.01,115.01,0.01,3200.01,115.01,0.01,3200.01,0.01,0.01,4450.01,0.01,0.01,2315.01,0.01,0.01,2315.01,115.01,0.01,0.01,115.01,0.01,0.01,0.01,0.01,4450.01,115.01,2750.01,4450.01,0.01,2750.01,0.01,0.01,2750.01,0.01,115.01,2750.01,2315.01,115.01,2190.01,3200.01,115.01,2190.01,3200.01,0.01,2190.01,2315.01,0.01,2190.01],\"F\":[4,0,1,2,3,4,4,5,6,7,4,8,9,10,11,4,0,3,9,8,8,6,5,12,13,1,0,8,11,4,7,6,11,10,8,3,2,14,15,4,7,10,9,4,12,15,14,13,4,15,12,5,4,4,13,14,2,1]}"
        }
    }
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

...

Deck of Cards

id	bimObjCreateAttachment

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

POST

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects/<object_id>attachments

URL: https://api.bimplus.net/v2/<team>/objects/<object_id>attachments

Example: https://api.bimplus.net/v2/bimplus/projects/objects/7cf910cb-e357-43f6-aa3a-b45c26380f75/attachments

JSON Structure:

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
size	optional	long integer	Size of the file to be attached to the project

Card

label	Description

Create a new attachment in a object.

Response

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label

Code Block

borderColor	GreenRed
lang	xml
title	Status


Status: 200 OK

JSON

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 201 Created

[3] 0: { id: "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e" name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang" }- 1: { id: "2d703abe-b4f9-407c-af53-a39c5b7ba872" name: "__5 999 Parklife Salzburg Lehen" }- 2: { id: "c480cc54-aec4-4bef-8d35-93bb090e1aba" name: "0811-Wohnhaus Kraus - Carport1" }

Code Block

borderColor	Red
lang	xml
title	JSON

Code Block

borderColor	Red
lang	xml
title	JSON

Get the attachment list from the object

Deck of Cards

id	bimGetObjAttachment

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects/<object_id>attachments

URL: https://api.bimplus.net/v2/<team>/objects/<object_id>attachments

Example: https://api.bimplus.net/v2/bimplus/projectsobjects/7cf910cb-e357-43f6-aa3a-b45c26380f75/attachments

Card

label	Description

Get all the attachments belonging to a specified object.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

[3] 0: { id: "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e" name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang" }- 1: { id: "2d703abe-b4f9-407c-af53-a39c5b7ba872" name: "__5 999 Parklife Salzburg Lehen" }- 2: { id: "c480cc54-aec4-4bef-8d35-93bb090e1aba" name: "0811-Wohnhaus Kraus - Carport1" }

Code Block

borderColor	Red
lang	xml
title	JSON

	xml
title	JSON

Delete all the attachments from the project

Deck of Cards

id	bimDeleteObjAttachment

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

DELETE

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects/<object_id>/attachments

URL: https://api.bimplus.net/v2/<team>/objects/<object_id>/attachments

Example: https://api.bimplus.net/v2/bimplus/projectsobjects/7cf910cb-e357-43f6-aa3a-b45c26380f75/attachments

Card

label	Description

Delete all the attachments from a specified project.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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


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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

Delete the object

Deck of Cards

id	bimObjDelete

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

DELETE

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects/<object_id>

URL: https://api.bimplus.net/v2/<team>/objects/<object_id>

Example: https://api.bimplus.net/v2/bimplus/objects/7cf910cb-e357-43f6-aa3a-b45c26380f75

Card

label	Description

Deletes a specified object.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

...

Deck of Cards

id	bimGetAttachmentList

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: attachments/<attachment_id>

URL: https://api.bimplus.net/v2/<team>/attachments/<attachment_id>

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

Card

label	Description

Get detailed information about a specified attachment.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK


lang	xml
title	Status


Status: 200 OK

[3] 0: { id: "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e" name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang" }- 1: { id: "2d703abe-b4f9-407c-af53-a39c5b7ba872" name: "__5 999 Parklife Salzburg Lehen" }- 2: { id: "c480cc54-aec4-4bef-8d35-93bb090e1aba" name: "0811-Wohnhaus Kraus - Carport1" }

Code Block

borderColor	Red
lang	xml
title	JSON

Code Block

borderColor	Red
lang	xml
title	JSON

Download the attachment

Deck of Cards

id	bimDownloadAttachment

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: attachments/<attachment_id>/download

URL: https://api.bimplus.net/v2/<team>/attachments/<attachment_id>/download

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

Card

label	Description

Download the content of a specified attachment.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

Update the attachment

Deck of Cards

id	bimUpdateAttachment

Card

label	Implementation Status

Service not finished yet !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: attachments/<attachment_id>

URL: https://api.bimplus.net/v2/<team>/attachments/<attachment_id>

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

JSON Structure:

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
size	optional	long integer	Size of the file to be attached to the project

Card

label	Description

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

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response		Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

Delete the Attachment

Deck of Cards

id	bimDeleteAttachment

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: attachments/<attachment_id>

URL: https://api.bimplus.net/v2/<team>/attachments/<attachment_id>

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

Card

label	Description

Deletes a specified attachment.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}Status: 200 OK

Issue Service

Anchor

	issueService
	issueService

...

Deck of Cards

id	bimGetIssueDetails

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: issues/<issue_id>

URL: https://api.bimplus.net/v2/<team>/issues/<issue_id>

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

Card

label	Description

Get details of an issue present in a project.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

[3] 0: { id: "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e" name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang" }- 1: { id: "2d703abe-b4f9-407c-af53-a39c5b7ba872" name: "__5 999 Parklife Salzburg Lehen" }- 2: { id: "c480cc54-aec4-4bef-8d35-93bb090e1aba" name: "0811-Wohnhaus Kraus - Carport1" }

Code Block

borderColor	Red
lang	xml
title	JSON

Get all the issue types

Deck of Cards

id	bimGetIssueTypest

Card

label	Implementation Status

Service not finished yet !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: issues/types

URL: https://api.bimplus.net/v2/<team>/issues/types

Example: https://api.bimplus.net/v2/bimplus/projectsissues/types

Card

label	Description

Get all the available issue types.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

	Green
lang	xml
title	Status


Status: 200 OK

[3] 0: { id: "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e" name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang" }- 1: { id: "2d703abe-b4f9-407c-af53-a39c5b7ba872" name: "__5 999 Parklife Salzburg Lehen" }- 2: { id: "c480cc54-aec4-4bef-8d35-93bb090e1aba" name: "0811-Wohnhaus Kraus - Carport1" }

Code Block

borderColor	Red
lang	xml
title	JSON

Code Block

borderColor	Red
lang	xml
title	JSON

Get details of the issue type

Deck of Cards

id	bimGetIssueTypeDetails

Card

label	Implementation Status

Service not finished yet !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: issues/types/<type_id>

URL: https://api.bimplus.net/v2/<team>/issues/types/<type_id>

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

Card

label	Description

Get details of a specified issue type.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK


title	Status


Status: 200 OK

[3] 0: { id: "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e" name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang" }- 1: { id: "2d703abe-b4f9-407c-af53-a39c5b7ba872" name: "__5 999 Parklife Salzburg Lehen" }- 2: { id: "c480cc54-aec4-4bef-8d35-93bb090e1aba" name: "0811-Wohnhaus Kraus - Carport1" }

Code Block

borderColor	Red
lang	xml
title	JSON

Code Block

borderColor	Red
lang	xml
title	JSON

Create a new pin for the issue

Deck of Cards

id	bimCreatePin

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

POST

Card

default	true
label	URL / Resource / JSON Structure

Resource: issues/<issue_id>/pins

URL: https://api.bimplus.net/v2/<team>/projects/issues/<issue_id>/pin

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

JSON Structure:

Name	Mandatory / Optional	Type	Description
issueId		string (guid)	The id of the issue to which the pin is related
objectId			The id of the object to which the pin is related
position	optional
normalVector	optional
createdAt	optional	date	The creation date

Card

label	Description

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

Response

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label

Code Block

borderColor	GreenRed
lang	xml
title	Status


Status: 200 OK

JSON

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 201 Created

[3] 0: { id: "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e" name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang" }- 1: { id: "2d703abe-b4f9-407c-af53-a39c5b7ba872" name: "__5 999 Parklife Salzburg Lehen" }- 2: { id: "c480cc54-aec4-4bef-8d35-93bb090e1aba" name: "0811-Wohnhaus Kraus - Carport1" }

Code Block

borderColor	Red
lang	xml
title	JSON

Code Block

borderColor	Red
lang	xml
title	JSON

Get all the pins of the issue

Deck of Cards

id	bimGetAllPins

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: issues/<issue_id>/pins

URL: https://api.bimplus.net/v2/<team>/issues/<issue_id>/pins

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

Card

label	Description

Get all the pins of a specified issue type.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

[3] 0: { id: "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e" name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang" }- 1: { id: "2d703abe-b4f9-407c-af53-a39c5b7ba872" name: "__5 999 Parklife Salzburg Lehen" }- 2: { id: "c480cc54-aec4-4bef-8d35-93bb090e1aba" name: "0811-Wohnhaus Kraus - Carport1" }

Code Block

borderColor	Red
lang	xml
title	JSON

	xml
title	JSON

Delete all the pins from the issue

Deck of Cards

id	bimDeleteAllPins

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

DELETE

Card

default	true
label	URL / Resource / JSON Structure

Resource: issues/<issue_id>/pins

URL: https://api.bimplus.net/v2/<team>/issues/<issue_id>/pins

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

Card

label	Description

Delete all the pins from a specified issue.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

Create a new comment for the issue

Deck of Cards

id	bimCreateComment

Card

label	Implementation Status

Service not finished yet !

Card

label	HTTP Method

POST

Card

default	true
label	URL / Resource / JSON Structure

Resource: issues/<issue_id>/comments

URL: https://api.bimplus.net/v2/<team>/issues/<issue_id>/comments

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

JSON Structure:

Name	Type	Description
issueId	string (guid)	The id of the issue to which the comment is related
text	string	The comment text
createdAt	string (date)	Creation date of the comment
author	string	The author of the comment

Card

label	Description

Create a new comment for a specified issue.

Response

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label

Code Block

borderColor	GreenRed
lang	xml
title	Status


Status: 200 OK

JSON

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 201 Created

[3] 0: { id: "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e" name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang" }- 1: { id: "2d703abe-b4f9-407c-af53-a39c5b7ba872" name: "__5 999 Parklife Salzburg Lehen" }- 2: { id: "c480cc54-aec4-4bef-8d35-93bb090e1aba" name: "0811-Wohnhaus Kraus - Carport1" }

Code Block

borderColor	Red
lang	xml
title	JSON

Code Block

borderColor	Red
lang	xml
title	JSON

Get all the comments of the issue

Deck of Cards

id	bimGetAllComments

Card

label	Implementation Status

Service not finished yet !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: issues/<issue_id>/comments

URL: https://api.bimplus.net/v2/<team>/issues/<issue_id>/comments

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

Card

label	Description

Get all the comments of a specified issue.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

[3] 0: { id: "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e" name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang" }- 1: { id: "2d703abe-b4f9-407c-af53-a39c5b7ba872" name: "__5 999 Parklife Salzburg Lehen" }- 2: { id: "c480cc54-aec4-4bef-8d35-93bb090e1aba" name: "0811-Wohnhaus Kraus - Carport1" }

Code Block

borderColor	Red
lang	xml
title	JSON

	xml
title	JSON

Delete the comment

Deck of Cards

id	bimDeleteComment

Card

label	Implementation Status

Service not finished yet !

Card

label	HTTP Method

DELETE

Card

default	true
label	URL / Resource / JSON Structure

Resource: issues/<issue_id>/comments/<comment_id>

URL: https://api.bimplus.net/v2/<team>/issues/<issue_id>/comments/<comment_id>

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

Card

label	Description

Deletes a specified comment.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

Create a new attachment for the issue

Deck of Cards

id	bimCreateAttachmentForIssue

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

POST

Card

default	true
label	URL / Resource / JSON Structure

Resource: issues/<issue_id>/attachments

URL: https://api.bimplus.net/v2/<team>/issues/<issue_id>/attachments

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

JSON Structure:

Name	Mandatory / Optional	Type	Description
objectIds	optional	string	The id of the issue 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
size	optional	long integer	Size of the file to be attached to the project

Card

label	Description

Creates a new attachment for a specified issue.

Response

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label

Code Block

borderColor	GreenRed
lang	xml
title	JSON	Status


Status: 200 OK

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 201 Created

[3] 0: { id: "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e" name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang" }- 1: { id: "2d703abe-b4f9-407c-af53-a39c5b7ba872" name: "__5 999 Parklife Salzburg Lehen" }- 2: { id: "c480cc54-aec4-4bef-8d35-93bb090e1aba" name: "0811-Wohnhaus Kraus - Carport1" }

Code Block

borderColor	Red
lang	xml
title	JSON

Code Block

borderColor	Red
lang	xml
title	JSON

Get the attachment list from the issue

Deck of Cards

id	bimGetAttachmentListFromIssue

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: issues/<issue_id>/attachments

URL: https://api.bimplus.net/v2/<team>/issues/<issue_id>/attachments

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

Card

label	Description

Gets the attachment list from a specified issue.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

	Green
lang	xml
title	Status


Status: 200 OK

[3] 0: { id: "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e" name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang" }- 1: { id: "2d703abe-b4f9-407c-af53-a39c5b7ba872" name: "__5 999 Parklife Salzburg Lehen" }- 2: { id: "c480cc54-aec4-4bef-8d35-93bb090e1aba" name: "0811-Wohnhaus Kraus - Carport1" }

Code Block

borderColor	Red
lang	xml
title	JSON

Code Block

borderColor	Red
lang	xml
title	JSON

Delete all the attachments from the issue

Deck of Cards

id	bimDeleteAttachmentFromIssue

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

DELETE

Card

default	true
label	URL / Resource / JSON Structure

Resource: issues/<issue_id>/attachments

URL: https://api.bimplus.net/v2/<team>/issues/<issue_id>/attachments

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

Card

label	Description

Delete all the attachments from a specified issue.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

Update the issue

Deck of Cards

id	bimUpdateIssue

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

PUT

Card

default	true
label	URL / Resource / JSON Structure

Resource: issues/<issue_id>

URL: https://api.bimplus.net/v2/<team>/issues/<issue_id>

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

JSON Structure:

Name	Type	Description
projectId	string (guid)	Id of the project
name	string	Name of the issue
description	string	Description of the issue
author	string	Author of the issue
status	string	Status of the issue
createdAt	string (date)	Creation date of the issue
dueDate	string (date)	The date in which the issue is planned to be finished
solution
classification	string
priority	string

Card

label	Description

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

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Status: 200 OK

Code Block

borderColor	GreenRed
lang	xml
title	Status

JSON

Card

label	Response

Code Block

borderColor	RedGreen
lang	xml
title	JSON	Status


Status: 200 OK
[3]
0:  {
id: "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

Delete the issue

Deck of Cards

id	bimDeleteIssue

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

DELETE

Card

default	true
label	URL / Resource / JSON Structure

Resource: issues/<issue_id>

URL: https://api.bimplus.net/v2/<team>/issues/<issue_id>

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

Card

label	Description

Deletes a specified issue.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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


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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

Pin Service

Anchor

	pinService
	pinService

...

Deck of Cards

id	bimGetPinDetails

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: pins/<pin_id>

URL: https://api.bimplus.net/v2/<team>/pins/<pin_id>

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

Card

label	Description

Get details of a specified pin.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

Status

title
borderColor	Green
lang	xml


Status: 200 OK

Status


Status: 200 OK

[3] 0: { id: "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e" name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang" }- 1: { id: "2d703abe-b4f9-407c-af53-a39c5b7ba872" name: "__5 999 Parklife Salzburg Lehen" }- 2: { id: "c480cc54-aec4-4bef-8d35-93bb090e1aba" name: "0811-Wohnhaus Kraus - Carport1" }

Code Block

borderColor	Red
lang	xml
title	JSON

Code Block

borderColor	Red
lang	xml
title	JSON

Update the pin

Deck of Cards

id	bimPinUpdate

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

PUT

Card

default	true
label	URL / Resource / JSON Structure

Resource: pins/<pin_id>

URL: https://api.bimplus.net/v2/<team>/pins/<pin_id>

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

JSON Structure:

Name	Mandatory / Optional	Type	Description
issueId		string (guid)	The id of the issue to which the pin is related
objectId			The id of the object to which the pin is related
position	optional
normalVector	optional
createdAt	optional	string (date)	The creation date

Card

label	Description

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

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Status: 200 OK

Code Block

borderColor	GreenRed
lang	xml
title	Status

JSON

Card

label	Response

Code Block

borderColor	RedGreen
lang	xml
title	JSON	Status


Status: 200 OK
[3]
0:  {
id: "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

Delete the pin

Deck of Cards

id	bimGetPinDetails

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

DELETE

Card

default	true
label	URL / Resource / JSON Structure

Resource: pins/<pin_id>

URL: https://api.bimplus.net/v2/<team>/pins/<pin_id>

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

Card

label	Description

Deletes a specified pin.

card

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

	Headers


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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

Import Service

Anchor

	importService
	importService

...

Deck of Cards

id	bimCreateProjectFromIFC

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

POST

Card

default	true
label	URL / Resource / JSON Structure

Resource: import

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

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

Card

label	Description

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

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Status: 200 OK

Code Block

borderColor	GreenRed
lang	xml
title	Status

JSON

Card

label	Response

Code Block

borderColor	RedGreen
lang	xml
title	JSON	Status


Status: 201 Created

[3] 0: { id: "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e" name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang" }- 1: { id: "2d703abe-b4f9-407c-af53-a39c5b7ba872" name: "__5 999 Parklife Salzburg Lehen" }- 2: { id: "c480cc54-aec4-4bef-8d35-93bb090e1aba" name: "0811-Wohnhaus Kraus - Carport1" }

Code Block

borderColor	Red
lang	xml
title	JSON

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

Deck of Cards

id	bimCreateSubProjectFromIFC

Card

label	Implementation Status

Service not finished yet !

Card

label	HTTP Method

POST

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects/<project_id>/import

URL: https://api.bimplus.net/v2/<team>/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.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Code Block

borderColor	Red
lang	xml
title	JSON

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200201 OKCreated

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

Authorization Service

Anchor

	AuthorizationService
	AuthorizationService

...

Deck of Cards

id	bimUpdateUserInfo

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

PUT

Card

default	true
label	URL / Resource / JSON Structure

Resource: users/<user_id>

URL: https://api.bimplus.net/v2//users/<user_id>

Example: https://api.bimplus.net/v2/users/b8615afc-99cc-4bcd-b0ca-ff0593ce15c6

JSON Structure:

Name	Type	Description
email	string	Email of the user
status	string
password	string	Password of the user

Card

label	Description

Update information about a specified user.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Code Block

borderColor	Red
lang	xml
title	JSON

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

Get information about the currently logged in user

...

Deck of Cards

id	bimCreateNewTeam

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

POST

Card

default	true
label	URL / Resource / JSON Structure

Resource: teams

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

JSON Structure:

Name	Mandatory / Optional	Type	Description
slug	optional	string	The unique name which will be used in the url
name	optional	string	Name of the team
owner	optional	string (guid)	The unique identifier of the user who will be the initial owner
totalStorage	optional	integer	The total storage allocated to the the team (the initial storage size as ordered in the shop)
storageStats	optional	integer	The storage statistics of the team
status	optional	string	Active / Inactive
teamWorksConnection	optional	string	Base64 encoded database connection string for legacy applications
dataStorageStatus	optional	string	Online / Offline

Card

label	Description

Create a new team and its related database.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Code Block

borderColor	Red
lang	xml
title	JSON

{

        "slug": "best-company",
        "name": "Best Company",
        "owner": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6",
        "totalStorage": 500000,
        "storageStats": null,
        "status": "Active",
        "teamWorksConnection": "RGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0O0luaXRpYWwgQ2F0YWxvZz1CaW1QbHVzLlRlbmFudC5BTUFaT05BLU1OVU8wMTcudGhlLWJlc3Q7VXNlciBJRD10aGUtYmVzdDtQYXNzd29yZD00YmZhZWVlZTM5NDBmZjI0ZjhhNjg2MmIxMzk3NzUyYWU1MjlkZDIzO0Nvbm5lY3QgVGltZW91dD0xMA==",
        "dataStorageStatus": "Online"
    }

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

borderColor	Red
lang	xml
title	JSON

{
    "id": "db038754-2598-4616-9ea2-2c0947f2e93a",
    "slug": "best-company",
    "name": "Best Company",
    "owner": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6",
    "totalStorage": 500000,
    "storageStats": {
        "usedSpace": 0,
        "numberOfProjects": 0,
        "numberOfMembers": 0,
        "totalSpace": 500000,
        "totalNumberOfProjects": 0,
        "totalNumberOfMembers": 0
    },
    "status": "Active",
    "teamWorksConnection": "RGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0O0luaXRpYWwgQ2F0YWxvZz1CaW1QbHVzLlRlbmFudC5BTUFaT05BLU1OVU8wMTcudGhlLWJlc3Q7VXNlciBJRD10aGUtYmVzdDtQYXNzd29yZD00YmZhZWVlZTM5NDBmZjI0ZjhhNjg2MmIxMzk3NzUyYWU1MjlkZDIzO0Nvbm5lY3QgVGltZW91dD0xMA==",
    "dataStorageStatus": "Online"
}

...

Deck of Cards

id	bimGetTeamInfo

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: teams/<team_id>

URL: https://api.bimplus.net/v2/teams/<team_id>

Example: https://api.bimplus.net/v2/teams/db038754-2598-4616-9ea2-2c0947f2e93a

Card

label	Description

Get information about a specified team.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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


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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

[3] 0: { id: "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e" name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang" }- 1: { id: "2d703abe-b4f9-407c-af53-a39c5b7ba872" name: "__5 999 Parklife Salzburg Lehen" }- 2: { id: "c480cc54-aec4-4bef-8d35-93bb090e1aba" name: "0811-Wohnhaus Kraus - Carport1" }

Code Block

borderColor	Red
lang	xml
title	JSON

Update information about the team

Deck of Cards

id	bimUpdateTeamInfo

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

PUT

Card

default	true
label	URL / Resource / JSON Structure

Resource: teams/<team_id>

URL: https://api.bimplus.net/v2/teams/<team_id>

Example: https://api.bimplus.net/v2/teams/db038754-2598-4616-9ea2-2c0947f2e93a

JSON Structure:

Name	Mandatory / Optional	Type	Description
slug	optional	string	The unique name which will be used in the url
name	optional	string	Name of the team
owner	optional	string (guid)	The unique identifier of the user who will be the initial owner
totalStorage	optional	integer	The total storage allocated to the the team (the initial storage size as ordered in the shop)
storageStats	optional	integer	The storage statistics of the team
status	optional	string	Active / Inactive
teamWorksConnection	optional	string	Base64 encoded database connection string for legacy applications
dataStorageStatus	optional	string	Online / Offline

Card

label	Description

Update information about a specified team.

card

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

label	Response

Code Block

borderColor	GreenRed
lang	xml
title	Status


Status: 200 OK

JSON

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

Get the team list in which the current logged in user is a member of

...

Deck of Cards

id	bimAddUserToTeam

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

POST

Card

default	true
label	URL / Resource / JSON Structure

Resource: <team_id>/members

URL: https://api.bimplus.net/v2/<team>/<team_id>/members

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

Card

label	Description

Add a specified user to a specified team.

Response

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label

Status: 200 OK

Code Block

borderColor	GreenRed
lang	xml
title	Status

JSON

Card

label	Response

Code Block

borderColor	Red
lang	xml
title	JSON
	Green
lang	xml
title	Status


Status: 201 Created

[3] 0: { id: "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e" name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang" }- 1: { id: "2d703abe-b4f9-407c-af53-a39c5b7ba872" name: "__5 999 Parklife Salzburg Lehen" }- 2: { id: "c480cc54-aec4-4bef-8d35-93bb090e1aba" name: "0811-Wohnhaus Kraus - Carport1" }

Code Block

borderColor	Red
lang	xml
title	JSON

Get the member list of the team

Deck of Cards

id	bimGetMemberListInfo

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: <team_id>/members

URL: https://api.bimplus.net/v2/<team>/<team_id>/members

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

Card

label	Description

Get information about a specified user.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

	Green
lang	xml
title	Status


Status: 200 OK

[3] 0: { id: "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e" name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang" }- 1: { id: "2d703abe-b4f9-407c-af53-a39c5b7ba872" name: "__5 999 Parklife Salzburg Lehen" }- 2: { id: "c480cc54-aec4-4bef-8d35-93bb090e1aba" name: "0811-Wohnhaus Kraus - Carport1" }

Code Block

borderColor	Red
lang	xml
title	JSON

Code Block

borderColor	Red
lang	xml
title	JSON

Update information about the user in the team

Deck of Cards

id	bimUpdateUserInfoInTeam

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

PUT

Card

default	true
label	URL / Resource / JSON Structure

Resource: <team_id>/members/<user_id>

URL: https://api.bimplus.net/v2/<team>/<team_id>/members/<user_id>

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

Card

label	Description

Update information about a specified user in a team.

Response

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label

Code Block

borderColor	GreenRed
lang	xml
title	Status


Status: 200 OK

JSON

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

Delete the user from the team

Deck of Cards

id	bimDeleteUserFromTeam

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

DELETE

Card

default	true
label	URL / Resource / JSON Structure

Resource: <team_id>/members/<user_id>

URL: https://api.bimplus.net/v2/<team>/<team_id>/members/<user_id>

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

Card

label	Description

Deletes a specified user from a team.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 13

New Version 14

Key

Delete all the issues from the project

Delete all the issues from the project

Get the Attachment List from the project

Delete all the attachments from the project

Get the project topology tree

Get the attachment list from the object

Delete all the attachments from the project

Delete the object

Download the attachment

Update the attachment

Delete the Attachment

Issue Service

Get all the issue types

Get details of the issue type

Create a new pin for the issue

Get all the pins of the issue

Delete all the pins from the issue

Create a new comment for the issue

Get all the comments of the issue

Delete the comment

Create a new attachment for the issue

Get the attachment list from the issue

Delete all the attachments from the issue

Update the issue

Delete the issue

Pin Service

Update the pin

Delete the pin

Import Service

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

Authorization Service

Get information about the currently logged in user

Update information about the team

Get the team list in which the current logged in user is a member of

Get the member list of the team

Update information about the user in the team

Delete the user from the team