Versions Compared

Key

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

...

  • Create a new project
  • Get the project list
  • Get the properties of the project
  • Update the project
  • Create an issue in the project
  • Get the issue list from the project
  • Delete all the issues from the project
  • Create a new attachment in the project
  • Get the attachment list from the project
  • Delete all the attachments from the project
  • Get the project topology
  • Get the project disciplines
  • Delete the project

...

Deck of Cards
idbimGetIssueList
Card
labelImplementation Status

 Service available !

Card
labelHTTP Method

GET

Card
defaulttrue
labelURL / Resource / JSON Structure

Resource: projects/<project_id>issues 

URLhttps://api.bimplus.net/v2/<company>/projects/<project_id>/issues

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

Card
labelDescription

Get all the issues assigned to a specified project.

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

...

Delete all the issues from the project

...

idbimDeleteIssueList
Card
labelImplementation Status

Image Removed Service available !

Card
labelHTTP Method

DELETE

Card
defaulttrue
labelURL / Resource / JSON Structure

Resource: projects/<project_id>issues 
URLhttps://api.bimplus.net/v2/<company>/projects/<project_id>/issues
Examplehttps://api.bimplus.net/v2/bimplus/projects/c8c8e6f2-4495-484c-929d-0049f1f9d4ff

Card
labelDescription

Delete all the issues belonging to a specified project.

Card
labelRequest
Code Block
borderColorGreen
langxml
titleHeaders

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

...

labelResponse
Code Block
borderColorGreen
langxml
titleStatus

Status: 200 OK

...

borderColorRed
langxml
titleJSON

...


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

...

Deck of Cards
idbimCreateAttachmentInProjectbimDeleteIssueList
Card
labelImplementation Status

 Service available !

Card
labelHTTP Method

POSTDELETE

Card
defaulttrue
labelURL / Resource / JSON Structure

Resource: projects/<project_id>/attachments id>issues 

URLhttps://api.bimplus.net/v2/<company>/projects/<project_id>/attachmentsissues

Examplehttps://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
labelDescription

Creates a new attachment in a project.

issues

Card
labelDescription

Delete all the issues belonging to a specified project.

Card
label
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
[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 the Attachment List from the project

...


...

Create a new attachment in the project

...

Deck of Cards
idbimCreateAttachmentInProject
Card
labelImplementation Status

Image Added Service available !

Card
labelHTTP Method

POST

Card
defaulttrue
labelURL / Resource / JSON Structure

Resource: projects/<project_id>/attachments 

URLhttps://api.bimplus.net/v2/<company>/

Deck of Cards
idbimGetAttachmentListFromProject
Card
labelImplementation Status

Image Removed Service available !

Card
labelHTTP Method

GET

Card
defaulttrue
labelURL / Resource / JSON Structure

Resource: projects/<project_id>/attachments attachments

URLExamplehttps://api.bimplus.net/v2/<company>bimplus/projects/<project_id>/attachmentsExamplehttps://api.bimplus.net/v2/bimplus/projects/c8c8e6f2-4495-484c-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
labelDescription

Get all the attachments belonging to a specified Creates a new attachment in a project.

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
[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 the

...

Attachment List from the project
Deck of Cards
idbimDeleteAttachmentListFromProjectbimGetAttachmentListFromProject
Card
labelImplementation Status

 Service available !

Card
labelHTTP Method

DELETEGET

Card
defaulttrue
labelURL / Resource / JSON Structure

Resource: projects/<project_id>/attachments 

URLhttps://api.bimplus.net/v2/<company>/projects/<project_id>/attachments

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

Card
labelDescription

Delete Get all the attachments belonging to a specified project.

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

...


Delete all the attachments from the project

...

Deck of Cards
idbimGetProjectDiscbimDeleteAttachmentListFromProject
Card
labelImplementation Status

 Service available !

Card
labelHTTP Method

GETDELETE

Card
defaulttrue
labelURL / Resource / JSON Structure

Resource: projects/<project_id>/disciplines attachments 

URLhttps://api.bimplus.net/v2/<company>/projects/<project_id>/disciplinesattachments

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

Card
labelDescription

Get the disciplines of a Delete all the attachments belonging to a specified project.

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
[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 the project topology tree

...

Deck of Cards
idbimDeleteProjectbimGetObject5
Card
labelImplementation Status

 Service available !

Card
labelHTTP Method

DELETEGET

Card
defaulttrue
labelURL / Resource / JSON Structure

Resource: projects/<project_id> id>/topology

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

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

Card
labelDescription

Deletes a specified projectGet the project topology tree.

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

...

parent": null,
    "name": null,
    "type": "Project",
    "children": [
        {
            "parent": "c8c8e6f2-4495-484c-929d-0049f1f9d4ff",
            "name": null,
            "type": "ID_TopologyDivision",
            "children": [],
            "id": "195db084-3715-4ebc-b164-3ee47a495b2e"
        }
    ],
    "id": "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
}


...

Get the project disciplines

...

Deck of Cards
idbimGetProjectDisc
Card
labelImplementation Status

Image Added Service available !

Card
labelHTTP Method

GET

Card
defaulttrue
labelURL / Resource / JSON Structure

Resource: projects/<project_id>/disciplines 

...

  • Create a new object
  • Get the object tree with full property list whose geometry type is "mesh"(default)
  • Get the object with no children and fully property list whose geometry type is "mesh"(default)
  • Get the full property list of the object without geometry
  • Get the project topology tree
  • Get the object tree with full property list without geometry
  • Get the optimized objects tree with selected property list whose geometry type is "ThreeJS"
  • Get the object tree with full property list whose geometry type is "compressed geometry mesh (meshblob)"
  • Get the object tree with selected property list whose geometry type is "ThreeJS" filtered by discipline
  • Get the object tree whose geometry type is "compressed geometry mesh (meshblob)" filtered by discipline
  • Update the object
  • Create a new attachment in the object
  • Get the attachment list from the object
  • Delete all attachments from the project
  • Delete the object

...

Create a new object

...

Deck of Cards
idbimGetObject1
Card
labelImplementation Status

Image Removed Service available !

Card
labelHTTP Method

POST

Card
defaulttrue
labelURL / Resource / JSON Structure

Resource: objects 

URLhttps://api.bimplus.net/v2/<company>/objects/projects/<project_id>/disciplines

Examplehttps://api.bimplus.net/v2/bimplus/projects

JSON Structure:

Name

Mandatory / Optional

Type

Description

parent

optional

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

 

Children of the object

Card
labelDescription

Creates a new object

/586b02be-43b8-4e27-b698-e067e85e38e2/disciplines

Card
labelDescription

Get the disciplines of a project.

Card
labelRequest
Code Block
borderColorGreen
langxml
titleHeaders

Authorization
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

[3]
0:    {
        "id": "c8c8e6f20f106af0-4495a919-484c44c5-929db211-0049f1f9d4ff15bd5ef620b6",
        "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 object tree with full property list whose geometry type is "mesh"(default)

...

ID_BuildingModel",
        "divisionId": "ac21b9a1-8853-4658-9fbf-0cf62340bd18",
        "divisionName": null,
        "revisions": []
    },
    {
        "id": "63b069d2-81df-4418-91de-8a954fa12924",
        "name": "ID_DesignModel_Timber",
        "divisionId": "ac21b9a1-8853-4658-9fbf-0cf62340bd18",
        "divisionName": null,
        "revisions": []
    },
    {
        "id": "30114b52-bc05-47c1-80b5-c7d5485d5840",
        "name": "ID_FinishModel",
        "divisionId": "ac21b9a1-8853-4658-9fbf-0cf62340bd18",
        "divisionName": null,
        "revisions": []
    },
    {
        "id": "09e623d4-1e12-4a77-b358-ea1d0b28e4a7",
        "name": "ID_RoomModel",
        "divisionId": "ac21b9a1-8853-4658-9fbf-0cf62340bd18",
        "divisionName": null,
        "revisions": []
    }
]


...

Delete the project

...

Deck of Cards
idbimDeleteProject
Card
labelImplementation Status

Image Added Service available !

Card
labelHTTP Method

DELETE

Card
defaulttrue
labelURL / Resource / JSON Structure

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

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

Card
labelDescription

Deletes a specified project.

Card
labelRequest
Code Block
borderColorGreen
langxml
titleHeaders

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatus

Status: 200 OK


Object Service
Anchor
objectService
objectService

...

  • Create a new object
  • Get the object tree with full property list whose geometry type is "mesh"(default)
  • Get the object with no children and fully property list whose geometry type is "mesh"(default)
  • Get the full property list of the object without geometry
  • Get the object tree with full property list without geometry (object topology tree)
  • Get the optimized objects tree with selected property list whose geometry type is "ThreeJS"
  • Get the object tree with full property list whose geometry type is "compressed geometry mesh (meshblob)"
  • Get the object tree with selected property list whose geometry type is "ThreeJS" filtered by discipline
  • Get the object tree whose geometry type is "compressed geometry mesh (meshblob)" filtered by discipline
  • Update the object
  • Create a new attachment in the object
  • Get the attachment list from the object
  • Delete all attachments from the project
  • Delete the object

...

Create a new object

...

Deck of Cards
idbimGetObject1
Deck of Cards
idbimGetObject2
Card
labelImplementation Status

 Service available !

Card
labelHTTP Method

GETPOST

/ JSON Structure
Card
defaulttrue
labelURL / Resource / JSON Structure

Resource

: objects 

URLhttps://api.bimplus.net/v2/<company>/objects

Examplehttps://api.bimplus.net/v2/bimplus/projects

JSON Structure:

Name

Mandatory / Optional

Type

Description

parent

optional

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

 

Children of the object

Resource: objects/<object_id> 

URLhttps://api.bimplus.net/v2/<company>/objects/<object_id>

Examplehttps://api.bimplus.net/v2/bimplus/projects

Card
labelDescription

Get the object tree with full property list whose geometry type is "mesh"(default)Creates a new object

Card
labelRequest
Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
lang
labelResponsexml
Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK


Code Block
borderColorRed
langxml
titleJSON
[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 the object tree with full property list

...

whose geometry type is "mesh"(default)
Deck of Cards
idbimGetObject4bimGetObject2
Card
labelImplementation Status

 Service available !

Card
labelHTTP Method

GET

Card
defaulttrue
labelURL / Resource / JSON Structure

Resource:  objectsobjects/<object_id>/nogeometryid> 

URLhttps://api.bimplus.net/v2/<company>/objects/<object_id>/nogeometry

Examplehttps://api.bimplus.net/v2/bimplus/projects

Card
labelDescription

Get the object tree with full property list of the object without geometrywhose geometry type is "mesh"(default)

Card
labelRequest
Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
langxml
Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK


Code Block
borderColorRed
langxml
titleJSON
[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

...

the full property list of the object without geometry
Deck of Cards
idbimGetObject5bimGetObject4
Card
labelImplementation Status

 Service available !

Card
labelHTTP Method

GET

Card
defaulttrue
labelURL / Resource / JSON Structure

Resource: objects/<object_id>/projecttreenogeometry

URLhttps://api.bimplus.net/v2/<company>/objects/<object_id>/projecttreenogeometry

Examplehttps://api.bimplus.net/v2/bimplus/projects

Card
labelDescription

Get the project topology tree.the full property list of the object without geometry

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
[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 the object tree with full property list without geometry (object topology tree)

...

Deck of Cards
idbimGetObject6
Card
labelImplementation Status

 Service available !

Card
labelHTTP Method

GET

Card
defaulttrue
labelURL / Resource / JSON Structure

Resource: objects/<object_id>/topology 

URLhttps://api.bimplus.net/v2/<company>/objects/<object_id>/topology

Examplehttps://api.bimplus.net/v2/bimplus/projects

Card
labelDescription

Get the object tree with full property list without geometry.

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

...