Note
This web page is under construction. The JSON Request and Reply (Request and Reply tab) for the API calls are not complete.

Note

Please use

Newwindowlink

title	http://bimplus-dev.mantro.net
url	http://bimplus-dev.mantro.net

for the testing purposes because our productive server

Newwindowlink

title	https://api.bimplus.net
url	https://api.bimplus.net

is not available to the market yet.

Bim+ Services

...

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/<company>/projects/<project_id>

Example: https://api.bimplus.net/v2/bimplus/projects/c8c8e6f2-4495-484c-929d-0049f1f9d4ff

JSON Structure:

Name	Mandatory / Optional	Type	Description
id	mandatory	guid	id of the project
name	optional	string	Name of the project
shortDescr	optional	string	Short description of the project
created	optional	date	Creation date of the project
changed	optional	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/<company>/projects/<project_id>/issues

Example: https://api.bimplus.net/v2/bimplus/projects/c8c8e6f2-4495-484c-929d-0049f1f9d4ff/issues

JSON Structure:

Name	Mandatory / Optional	Type	Description
projectId	mandatory	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	date	Creation date of the issue
dueDate	optional	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

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"projectId": "c8c8e6f20d2ce2cc-44953588-484c45d6-929da59a-0049f1f9d4fff6b89ebed34e",
"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"
}": "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"
}

Get the Issue List from the project

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/<company>/projects/<project_id>/issues

Example: https://api.bimplus.net/v2/bimplus/projects/c8c8e6f2-4495-484c-929d-0049f1f9d4ff

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

[3] 0: { id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff" 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 issues from the project

Deck of Cards

id	bimDeleteIssueList

Card

label	Implementation Status

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/<company>/projects/<project_id>/issues
Example: https://api.bimplus.net/v2/bimplus/projects/c8c8e6f2-4495-484c-929d-0049f1f9d4ff

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
: 200 OK

[3] 0: { id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff" 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 attachment in the project

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/<company>/projects/<project_id>/attachments

Example: https://api.bimplus.net/v2/bimplus/projects/c8c8e6f2-4495-484c-929d-0049f1f9d4ff/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	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

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
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	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/<company>/projects/<project_id>/attachments

Example: https://api.bimplus.net/v2/bimplus/projects/c8c8e6f2-4495-484c-929d-0049f1f9d4ff/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

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: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
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	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/<company>/projects/<project_id>/attachments

Example: https://api.bimplus.net/v2/bimplus/projects/c8c8e6f2-4495-484c-929d-0049f1f9d4ff

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	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
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	bimGetProjectDisc

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects/<project_id>/disciplines

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

Example: https://api.bimplus.net/v2/bimplus/projects/c8c8e6f2-4495-484c-929d-0049f1f9d4ff/disciplines

Card

label	Description

Get the disciplines of a 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

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
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	bimDeleteProject

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

DELETE

Card

default	true
label	URL / Resource / JSON Structure

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

Example: https://api.bimplus.net/v2/bimplus/projects/c8c8e6f2-4495-484c-929d-0049f1f9d4ff

Card

label	Description

Deletes 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

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
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	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/<company>/issues/<issue_id>/commentsExample: https://api.bimplus.net/v2/bimplus/projects

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

JSON Structure:

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

Card

label	Description

Create a new comment for 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

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
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	bimAuthenticateToken

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

POST

Card

default	true
label	URL / Resource / JSON Structure

Resource: authorize

URL: https://api.bimplus.net/v2/<company>/authorize

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

Card

label	Description

Authenticate by requesting and receiving a token.

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


{
 "user_id" : "test@bimplus.net",
 "password" : "test"
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON	JSON


{
"access_token": "9c1874a62c974dcfa75e0132c423a088"
"expires_in": 2591999
"token_type": "BimPlus"
}
[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
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 token information

Deck of Cards

id	bimGetTokenInfo

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: tokeninfo?access_token=<token>

URL: https://api.bimplus.net/v2/<company>/tokeninfo?access_token=<token>

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

Card

label	Description

Get information about a specified token.

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: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
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	bimCreateUser

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

POST

Card

default	true
label	URL / Resource / JSON Structure

Resource: users

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

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

JSON Structure:

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

Card

label	Description

Creates a new user account.

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: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
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	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/<company>/users/<user_id>

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

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

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: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
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	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/<company>/<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: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
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	Green
lang	xml
title	Test

test for null

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 3

New Version 4

Key

Bim+ Services

Get the Issue List from the project

Delete all the issues from the project

Create a new attachment in the project

Get token information

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 3

New Version 4

Key

Bim+ Services

Get the Issue List from the project

Delete all the issues from the project

Create a new attachment in the project

Get token information