Help us improve the Bimplus API doc by providing your valuable comments. You can find the comment section at the bottom of the page.

 

Developers please use (stage version of Bimplus API) and (stage version of Shop/Portal) for testing purposes. Please use these login details(Login: bimplus, password: Bimplus) if you receive a login dialog before our portal loads.

Project relevant services

Administration relevant services

Other services

Project Service


Model Service


Object Service


ElementType Service


Attachment Service


Issue Service


Pin Service


Comment Service


Import Service


Slideshow Service


 

Authorization Service


User Management Service


Team Management Service


Membership Management Service


Rights & Roles Service


User/Team Activation/Deactivation Service


Database Server Statistics Service


Database Move Service


Messaging Service


Log Service


BTW(Bim Team Work) related Service


 

Project Service


A Project is basically a holder which contains building models.

Create a new project
 POST
 Resource: projects 

URL: https://api-stage.bimplus.net/v2/<team_slug>/projects

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

JSON Structure

Name

Mandatory / Optional

Type

Description

name

mandatory

string

Name of the project

shortDescr

optional

string

Short description of the project

created

will be ignored

string (date)

Creation date of the project

 Creates a new project.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
{
"name" : "Your Awesome Building",
"shortDescr" : "Example for creating a project"
}
Status: 201 Created
{
"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"
}

Get the Project List
 GET
 

Resource: projects 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/projects

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

 Gets the available project list with main properties.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK
[
    {
        "id": "586b02be-43b8-4e27-b698-e067e85e38e2",
        "name": "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang",
        "shortDescr": "Hey, i am your favourite test entry",
        "thumbnail": null,
        "created": "2013-05-01T09:33:18",
        "changed": "2013-05-01T09:33:18",
        "hasWriteAccess": false,
        "teamSlug": "company1",
        "rights": {
            "projectAdmin": false,
            "projectDelete": false,
            "projectEdit": false,
            "modelsCreate": false,
            "modelsViewAll": false
        }
    },
    {
        "id": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
        "name": "Your Awesome Building",
        "shortDescr": "Example for creating a project",
        "thumbnail": null,
        "created": "0001-01-01T00:00:00",
        "changed": "0001-01-01T00:00:00",
        "hasWriteAccess": true,
        "teamSlug": "best-company",
        "rights": {
            "projectAdmin": true,
            "projectDelete": true,
            "projectEdit": true,
            "modelsCreate": true,
            "modelsViewAll": true
        }
    },
    {
        "id": "4e87944a-a477-4e4c-862e-e723dcb43066",
        "name": "UC_Fly-over Kerensheide",
        "shortDescr": null,
        "thumbnail": null,
        "created": "2013-05-10T07:13:38",
        "changed": "2013-05-16T07:34:56",
        "hasWriteAccess": false,
        "teamSlug": "company2",
        "rights": {
            "projectAdmin": false,
            "projectDelete": false,
            "projectEdit": false,
            "modelsCreate": false,
            "modelsViewAll": true
        }
    }
]

Get the Project Properties
 GET
 

Resource: projects/<project_id>

URLhttps://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>

Examplehttps://api-stage.bimplus.net/v2/bimplus/projects/586b02be-43b8-4e27-b698-e067e85e38e2

 Get all the project properties of a project using its id.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK
{
    "name": "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang",
    "shortDescr": "Hey, i am your favourite test entry",
    "thumbnail": null,
    "created": null,
    "changed": null,
    "disciplines": [
        {
            "id": "0f106af0-a919-44c5-b211-15bd5ef620b6",
            "name": "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": []
        }
    ],
    "rights": {
            "projectAdmin": false,
            "projectDelete": false,
            "projectEdit": false,
            "modelsCreate": false,
            "modelsViewAll": true
        },
    "id": "586b02be-43b8-4e27-b698-e067e85e38e2"
}

Update the project
 PUT
 Resource: projects/<project_id>

URLhttps://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>

Examplehttps://api-stage.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

will be ignored

string (date)

Creation date of the project

changed

will be ignored

string (date)

Changed date of the project

 Update or replace a specified existing project with a new one.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
{
    "properties": {
        "MainFloorArea": "456m²",
        "Architect": {
            "name": "NemetschekTech.GmbH",
            "phone1": "089/12793-1115",
            "phone2": "0171/71384483",
            "email": "MyName@Nemetschek.com",
            "city": "Munich",
            "zip": "81829",
            "street": "Konrad-Zuse-Platz1"
        },
        "Customer": {
            "name": "Bimplus customer",
            "phone1": "001-201-1279345",
            "email": "MyName@Nemetschek.com",
            "city": "New Jersy",
            "zip": "08201"
        }
    }
}
Status: 200 OK

Create an issue in the project
 POST
 

Resource: projects/<project_id>issues

URLhttps://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/issues

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

JSON Structure

Name

Mandatory / Optional

Type

Description

shortIdwill be ignorednumberReadable unique issue number

projectId

will be ignored

string (guid)

Id of the project

name

optional

string

Name of the issue

description

optional

string

Description of the issue

author

optional

object

Author of the issue

responsibleoptionalobjectResponsible person for the issue

status

optional

string

Status of the issue. Should have one of the values: Open, Solved or Closed

createdAt

will be ignored

string (date)

Creation date of the issue

dueDate

optional

string (date)

The date in which the issue is planned to be finished

solution

optional

string

The proposed solution for the issue

classification

optional

string

The classification to which the issues belongs

priority

optional

string

The priority of the issue. Should have one of the values: Low, Medium or High

 Creates a new issue in a project.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
{
"name": "Fire Exit Wrong",
"description": "The fire exit is in the wrong place",
"author" : { "id" : "92fa66c6-4114-d68e-974c-0ff78a49fda8" },
"responsible" : { "id" : "11fa66c6-4114-d68e-974c-0ff78a49fda8" },
"status": "open",
"dueDate": "2013-06-05T10:05:00",
"classification": "",
"priority": "very high"
}
Status: 201 Created
{
    "shortId": 1
    "projectId": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
    "name": "Fire Exit Wrong",
    "description": "The fire exit is in the wrong place",
    "author" : { "id" : "92fa66c6-4114-d68e-974c-0ff78a49fda8" },
    "responsible" : { "id" : "11fa66c6-4114-d68e-974c-0ff78a49fda8" },  
    "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
 GET
 Resource: projects/<project_id>issues 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/issues

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

 Get all the issues assigned to a specified project.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK
[
    {
        "shortId": 1,
        "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"
    },
    {
        "shortId": 2,
        "projectId": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
        "name": "Geometry information missing for wall",
        "description": "The geometry information is missing for the wall in the kitchen",
        "author": "Mr. Architect",
        "status": "open",
        "createdAt": "2013-06-02T10:05:00+00:00",
        "dueDate": "2013-06-05T10:05:00+00:00",
        "solution": null,
        "classification": "",
        "priority": "high",
        "revision": null,
        "id": "a171bc90-b03f-4ddd-9794-cf77f424f4e2"
    }
]

Delete all the issues from the project
 DELETE
 Resource: projects/<project_id>issues 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/issues

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

 Delete all the issues belonging to a specified project.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK

Create a new attachment in the project
 POST
 

Resource: projects/<project_id>/attachments 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/attachments

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

JSON Structure: Please note that all the information required for this call will be taken from the document that you attach and hence the request of this call has no body.

Name

Mandatory / Optional

Type

Description

objectIds

will be ignored

string

The id of the project objects to which the file has to be attached

fileName

will be ignored

string

Name of the file to be attached to the project

type

will be ignored

string

Mime type

size

will be ignored

integer

Size of the file to be attached to the project

createdAtwill be ignoredstringCreation time of the attachment
creatorwill be ignoredobjectThe user who created the attachment
 Creates a new attachment in a project.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: multipart/form-data

Status: 201 Created
   {
        "objectIds": [
            "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
        ],
        "fileName": "Building_Plan.jpg",
        "type": "image/jpeg",
        "size": 211258,
        "createdAt": "2013-12-11T10:47:39",
        "creator": {
        "id": "e18941f4-a809-2d01-d27d-cd251f2b6cb6",
        "email": "test@bimplus.net",
        "firstname": "First Name",
        "lastname": "Second Name",
        "company": "Best-Company",
        "fullname": "First Name Second Name",
        "displayname": "Best-Company",
        "info": "",
        "gender": "",
        "phoneWork": "",
        "phoneHome": "",
        "fax": "",
        "mobile": "",
        "birthDate": "0000-00-00",
        "address": {
            "street": "Westermeier str.",
            "streetNr": "10",
            "zip": "81829",
            "city": "München",
            "country": "Germany"
        },
        "preferedLanguage": "en"
       },
        "id": "6cea110a-88f4-43ac-9a00-ebaf677be333"
    }

Get the Attachment List from the project
 GET
 Resource: projects/<project_id>/attachments 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/attachments

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

 Get all the attachments belonging to a specified project.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK
    {
        "objectIds": [
            "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
        ],
        "fileName": "Building_Plan.jpg",
        "type": "image/jpeg",
        "size": 211258,
        "createdAt": "2013-12-11T10:47:39",
        "creator": {
        "id": "e18941f4-a809-2d01-d27d-cd251f2b6cb6",
        "email": "test@bimplus.net",
        "firstname": "First Name",
        "lastname": "Second Name",
        "company": "Best-Company",
        "fullname": "First Name Second Name",
        "displayname": "Best-Company",
        "info": "",
        "gender": "",
        "phoneWork": "",
        "phoneHome": "",
        "fax": "",
        "mobile": "",
        "birthDate": "0000-00-00",
        "address": {
            "street": "Westermeier str.",
            "streetNr": "10",
            "zip": "81829",
            "city": "München",
            "country": "Germany"
        },
        "preferedLanguage": "en"
       },
        "id": "6cea110a-88f4-43ac-9a00-ebaf677be333"
    }

Delete all the attachments from the project
 DELETE
 Resource: projects/<project_id>/attachments 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/attachments

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

 Delete all the attachments belonging to a specified project.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK

Get the project topology tree
 GET
 Resource: projects/<project_id>/topology

URLhttps://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/topology

Examplehttps://api-stage.bimplus.net/v2/bimplus/projects/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e/topology

 Get the project topology tree.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK
{
    "parent": null,
    "name": null,
    "type": "Project",
    "children": [
        {
            "parent": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
            "name": null,
            "type": "ID_TopologyDivision",
            "children": [],
            "id": "195db084-3715-4ebc-b164-3ee47a495b2e"
        }
    ],
    "id": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
}

Get the project layers
 GET
 Resource: projects/<project_id>/disciplines 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/disciplines

Examplehttps://api-stage.bimplus.net/v2/bimplus/projects/586b02be-43b8-4e27-b698-e067e85e38e2/disciplines

 Get the layers of a project.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK
[
    {
        "id": "0f106af0-a919-44c5-b211-15bd5ef620b6",
        "name": "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": []
    }
]

Create / Upload a thumbnail to the project
 POST
 Resource: projects/<project_id>/thumbnail

URLhttps://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/thumbnail

Examplehttps://api-stage.bimplus.net/v2/bimplus/projects/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e/thumbnail

 Creates or uploads a thumbnail to the project.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: multipart/form-data

Thumbnail API call:

Status: 201 Created
{
fileName: "MyThumbnail.jpg"
type: "image/jpeg"
size: 5262
id: "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
}

Download the thumbnail
 GET
 Resource: thumbnail/<thumbnail_id>

URLhttps://api-stage.bimplus.net/v2/<team_slug>/thumbnail/<thumbnail_id>

Examplehttps://api-stage.bimplus.net/v2/bimplus/thumbnail/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e

 Downloads the thumbnail.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: multipart/form-data
Status: 200 OK

Delete the project
 DELETE
 Resource: projects/<project_id> 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>

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

 Deletes a specified project.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK

 

Model Service


A Model is basically a technical building plan which could be created or imported. 

Create a new model
 POST
 

Resource: divisions 

URL: https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/divisions

Examplehttps://api-stage.bimplus.net/v2/bimplus/projects/743a24f9-baaa-41b9-90b3-91717238043c/divisions

JSON Structure

Name

Mandatory / Optional

Type

Description

name

mandatory

string

Name of the model

description

optional

string

Short description of the model

projectId

will be ignored

string (guid)

Id of the project to which the model belongs

topologyIdoptionalstring (guid)Id of the topology to which the model belongs
disciplinesoptionalobjectThe discipline list of the model
 Creates a new model.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
{
 "name":"Model D", 
 "description":"Creating a model via API"
}
Status: 201 Created
{
    "name": "Model D",
    "description": "Creating a model via API",
    "projectId": "743a24f9-baaa-41b9-90b3-91717238043c",
    "id": "afbb314f-fdde-43e7-9a49-90e16c1a6131"
}

Get the list of existing models inside a project
 GET
 

Resource: divisions 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/divisions

Examplehttps://api-stage.bimplus.net/v2/bimplus-gmbh/projects/743a24f9-baaa-41b9-90b3-91717238043c/divisions

 Gets the list of existing models inside a project.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK
[
    {
        "name": "Model A - Vogel",
        "description": null,
        "projectId": "743a24f9-baaa-41b9-90b3-91717238043c",
        "topologyId": "fc4be8b1-bf85-4c6f-b9c2-bac6474ddb1d",
        "id": "d81494b9-9731-4d2e-8fbe-da62f5270182"
    },
    {
        "name": "Model B - house sketchup",
        "description": null,
        "projectId": "743a24f9-baaa-41b9-90b3-91717238043c",
        "topologyId": "2d20d707-9c18-44c0-92f4-282948cd5cf5",
        "id": "deec1913-2c6e-4580-a40f-7e1ad33a6300"
    },
    {
        "name": "Model C - Nemetschek",
        "description": null,
        "projectId": "743a24f9-baaa-41b9-90b3-91717238043c",
        "topologyId": "d762b01d-6e63-4c68-9192-fc62faccbe87",
        "id": "e687b45b-d90d-4361-94ab-baf269588c0a"
    }
]

Get the model details
 GET
 

Resource: divisions/<division_id>

URLhttps://api-stage.bimplus.net/v2/<team_slug>/divisions/<division_id>

Examplehttps://api-stage.bimplus.net/v2/bimplus-gmbh/divisions/e687b45b-d90d-4361-94ab-baf269588c0a

 Get all the details of a model using its id.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK
{
    "name": "Model C - Nemetschek",
    "description": null,
    "projectId": "743a24f9-baaa-41b9-90b3-91717238043c",
    "topologyId": "d762b01d-6e63-4c68-9192-fc62faccbe87",
    "disciplines": [
        "0f106af0-a919-44c5-b211-15bd5ef620b6",
        "09e623d4-1e12-4a77-b358-ea1d0b28e4a7"
    ],
    "id": "e687b45b-d90d-4361-94ab-baf269588c0a"
}

Get the list of discipines from the model
 GET
 

Resource: divisions/<division_id>/disciplines

URLhttps://api-stage.bimplus.net/v2/<team_slug>/divisions/<division_id>/disciplines

Examplehttps://api-stage.bimplus.net/v2/bimplus-gmbh/divisions/e687b45b-d90d-4361-94ab-baf269588c0a/disciplines

 Get all the details of a model using its id.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK
[
    {
        "category": "/1/",
        "name": "ID_BuildingModel",
        "ifcType": null,
        "id": "0f106af0-a919-44c5-b211-15bd5ef620b6"
    },
    {
        "category": "/2/",
        "name": "ID_RoomModel",
        "ifcType": null,
        "id": "09e623d4-1e12-4a77-b358-ea1d0b28e4a7"
    }
]

Update the model
 PUT
 Resource: divisions/<division_id>

URLhttps://api-stage.bimplus.net/v2/<team_slug>/divisions/<division_id>

Examplehttps://api-stage.bimplus.net/v2/bimplus-gmbh/divisions/e687b45b-d90d-4361-94ab-baf269588c0a

JSON Structure

Name

Mandatory / Optional

Type

Description

name

mandatory

string

Name of the model

description

optional

string

Short description of the model

projectId

optional

string (guid)

Id of the project to which the model belongs

topologyIdoptionalstring (guid)Id of the topology to which the model belongs
disciplinesoptionalobjectThe discipline list of the model
 Update or replace a specified existing model with a new one.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
{
 "name":"Model D", 
 "description":"Updating the model D"
}
Status: 200 OK

Delete the model
 DELETE
 Resource: divisions/<division_id> 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/divisions/<division_id>

Examplehttps://api-stage.bimplus.net/v2/bimplus-gmbh/divisions/e687b45b-d90d-4361-94ab-baf269588c0a

 Deletes a specified project.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK

 

Object Service


Objects are the primary component of the project tree and it exists in two forms.

Please see the detailed structure of the issue in the Object Model

Create a new object
 POST
 

Resource: objects 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/objects

Examplehttps://api-stage.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

 Creates a new object
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
{
    "parent": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
    "type": "Wall",
    "attributes": {
        "element": {
            "isparent": false,
            "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]}"
        }
    }
}
Status: 201 Created
{
    "id": "7cf910cb-e357-43f6-aa3a-b45c26380f75",
    "parent": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
    "type": "Wall",
    "attributes": {
        "element": {
            "isparent": false,
            "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]}"
        }
    }
}

Get the object details
 GET
 Resource: objects/<object_id> 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/objects/<object_id>

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

 Gets the details of an object
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK
{
    "id": "7cf910cb-e357-43f6-aa3a-b45c26380f75",
    "type": "Wall",
    "attributes": {
        "element": {
            "isparent": false,
            "nr": 0,
            "matrix": "AAAAAAAA8D8AAAAAAAAAgAAAAAAAAACAINejcP1YsEAAAAAAAAAAgAAAAAAAAPA/AAAAAAAAAIAK16Nw/fy2QAAAAAAAAACAAAAAAAAAAIAAAAAAAADwPwAArkfheoS/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8=",
            "elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
            "logparentid": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
            "divisionid": "ac21b9a1-8853-4658-9fbf-0cf62340bd18"
        },
        "general": {
            "name": "Brickwall",
            "isobjectvalid": true
        },
        "allplan": {
            "allplan_guid": "08b8195a-a2ad-11e2-9993-002215ea7d6b",
            "allplan_id": 2065507287,
            "allplan_text": "<PP>Wall",
            "dateofexport": "2013-05-01T09:32:13"
        },
        "geometry": {
            "mesh": "{\"C\":0,\"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]}"
        }
    }
}

Get the full property list of the object without geometry
 GET
 Resource: objects/<object_id>/nogeometry

URLhttps://api-stage.bimplus.net/v2/<team_slug>/objects/<object_id>/nogeometry

Examplehttps://api-stage.bimplus.net/v2/bimplus/objects/7cf910cb-e357-43f6-aa3a-b45c26380f75/nogeometry

Get the full property list of the object without geometry
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK
{
    "id": "7cf910cb-e357-43f6-aa3a-b45c26380f75",
    "type": "Wall",
    "attributes": {
        "element": {
            "isparent": false,
            "nr": 0,
            "matrix": "AAAAAAAA8D8AAAAAAAAAgAAAAAAAAACAINejcP1YsEAAAAAAAAAAgAAAAAAAAPA/AAAAAAAAAIAK16Nw/fy2QAAAAAAAAACAAAAAAAAAAIAAAAAAAADwPwAArkfheoS/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8=",
            "elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
            "logparentid": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
            "divisionid": "ac21b9a1-8853-4658-9fbf-0cf62340bd18"
        },
        "general": {
            "name": "Brickwall",
            "isobjectvalid": true
        },
        "allplan": {
            "allplan_guid": "08b8195a-a2ad-11e2-9993-002215ea7d6b",
            "allplan_id": 2065507287,
            "allplan_text": "<PP>Wall",
            "dateofexport": "2013-05-01T09:32:13"
        }
    }
}

Get the object tree with full property list without geometry (object topology tree)
 GET
 Resource: objects/<object_id>/topology 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/objects/<object_id>/topology

Examplehttps://api-stage.bimplus.net/v2/bimplus/objects/7cf910cb-e357-43f6-aa3a-b45c26380f75/topology

 Get the object tree with full property list without geometry.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK
{
    "parent": null,
    "name": "Brickwall",
    "type": "Project",
    "children": [],
    "id": "7cf910cb-e357-43f6-aa3a-b45c26380f75"
}

Get the optimized objects tree with selected property list whose geometry type is "ThreeJS"
 GET
 Resource: objects/<object_id>/geometries/threejs 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/objects/<object_id>/geometries/threejs

Examplehttps://api-stage.bimplus.net/v2/bimplus/objects/7cf910cb-e357-43f6-aa3a-b45c26380f75/geometries/threejs

 Get the optimized objects tree with selected property list whose geometry type is "ThreeJS".
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK
{
    "elementsCount": 1,
    "viewbox": {
        "x": -5081.562,
        "y": 5005.8785,
        "z": 1231.1029999999996,
        "width": 5950,
        "height": 5540.835,
        "depth": 7065.71
    },
    "colors": [
        -9868951
    ],
    "objects": [
        {
            "id": "f5cc3c6c-1fdf-499d-a38d-0582adadc216",
            "type": "RoofLayer",
            "attributes": {
                "geometry": {
                    "threejs": {
                        "faces": [
                            0,
                            2,
                            1,
                            3,
                            0,
                            5,
                            3,
                            9,
                            1,
                            1,
                            14,
                            1,
                            5,
                            6,
                            15,
                            12,
                            1,
                            7,
                            4,
                            13,
                            14
                        ],
                        "vertices": [
                            -2106.562,
                            7588.114,
                            -2301.752,
                            -8056.562,
                            7588.114,
                            -2301.752,
                            -8056.562,
                            -880.999,
                            -4742.212,
                            6700,
                            -880.999,
                            -4742.212,
                            7412.539,
                            -1821.578,
                            -5522.212,
                            7412.539,
                            -1821.578
                        ],
                        "metadata": {
                            "formatVersion": 3,
                            "colorid": 0
                        }
                    }
                },
                "quantity": {
                    "length": 7065.71,
                    "height": 150,
                    "volume": 7911354818.818842,
                    "area": 52742365.4587924
                },
                "general": {
                    "name": "<PP>RoofLayer"
                }
            }
        }
    ]
}

Get the object tree with full property list whose geometry type is "compressed geometry mesh (meshblob)"
 GET
 Resource: objects/<object_id>/geometries/meshblob 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/objects/<object_id>/geometries/meshblob

Examplehttps://api-stage.bimplus.net/v2/bimplus/objects/7cf910cb-e357-43f6-aa3a-b45c26380f75/geometries/meshblob

 Get the object tree with full property list whose geometry type is "compressed geometry mesh (meshblob)".
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK
{
    "elementsCount": 1,
    "objects": [
        {
            "id": "7cf910cb-e357-43f6-aa3a-b45c26380f75",
            "parent": "00000000-0000-0000-0000-000000000000",
            "type": "Wall",
            "attributes": {
                "geometry": {
                    "compress": true,
                    "picture": "H4sIAAAAAAAEANVXW3PbRBTWylIsuUmctml6T900t7aua+eetiHOndAQDLS8pBnhyzYVUeQiyR0cGJ545y9QGB54YYY3HvkXPPetQLlDuV/2E7uqiEfUMzRDkWc/zfl0tHvO2XPOWhKRJOkPduGOq1VmcLVQmPE8xywVzLJXc+iV+k06nE69QB3XrNpTQ9lcLpPNjExmxzIjufHRbDo1V7OgOGXTmucUrXSqUCtZZvkyrV+pblJ7yq5Zloo10qt0i3pu+QbdzKxe9UxrxSw5RaeemZstunTBYk9tr1C16rRCnTh7Qb1ZNW1PoZUNqlwvlqm2ZTxXrJg1t33LmKV2xbQ3nKplUcVjRsrL87FYTFGU2G3yfN316FZmDg/LHrPbzSxRmzpmObNiut6LubW1SFsCO9jSzJfdiMb6+luPwsQFFpfH28JFtmm7ZmFP5OrVmu3NOE6xjoRuUq03Sk0kJMyG4h4el6WaWYGsxwAKQGWQSKg/s5pqajoURfxW0apRw5A0TBbrkCTlJ/Z+eJU97IFsFGWjJBtl2ajIBpWN67KxIRs3ZMOUjZdkY1N6cGnxuMwvacelwNj/QX3AzBbDZEa6quGa21Qzbv01Jwv0QFO2ra3De03TNXbr4EPBPj3+xfeP7vc3Y1rgvc5uh/hQ1Efl/a4W9r/zHqYF3idQkXzEkQgSEZnQ11QW+RWOAtRbAW2AdkASgIn0vYB9gP2ATsABQBfgIADB1w8DjsAQXRiSgiGRrSK8n74dRwHHAMcB3YATAMyjnwT0AE4BegF9gH7AAGAQcBpwBnAWkAacA2QA5wFZQA4wxKBNiyf+FrqHWow98C0eBowARgFjgHHABGAScAFwEXAJa7WoiHZzm4NEIa+QOtlGxrS0YMn7g9felEsf5F+eSnz8zkfX8q92vr90Z/uNaYL9w9T3nv2wW5Xea1Ro26EgHgQK7VxBLNGgkAzP0PV2o0LHDoUGG/ZyBUE0KOzbodCwxP4dRooZ/CVfezdPOiO8CBQORCwRKHRFGBkoHIxw05eP3c6TQxF7ESgcjtiLQOFIRKiFgopaabqy1BLdMO0Y+0uJriHzXPfvKLejXPDz7TgnIOA0Id2cUPhr5AQn0G1bQKQ4AQH/a8lJTkBAVyI9nND4a+QUJ9AqUHyklxMJ7jjp4wQE5Dbp50Qrf40MhAzz5xgMTepbejpkGNKfnOEEBKQ7OcuJdhGPdGgV35dzITt8XzKhAKEiyHlOQEAFkCwnOoS3udCyvsZQ6BUsrQ43s51oO/BLxReDG3u9iYOOqyzb3vBQOrXllquOZZYeHGIj7ARjv4cfXaXx8eJoeXQsNzk8QrMTk+v+EaRPwRs0QL8TPgFpVEjTkMaElIc0LqQZSBNCmoU0KaQ5SBeENA/popAWIF0S0iJ2Hyb8x6GIPtHjKDhNX+Jp6tcQogSj9SfD7LRgl8NsXrBPhdkZwV7mSekn5qxgV8K6c4J9Oqw7L9jVsO6CYJ8Js4uCLYTYpHBJE61ENIykcEsTDUK0gaRwTRNlL4o7KdzTfmUfByiTH9gdlZEMXMRnhygxnCP4tP+Gje/YwLGRFG5r+MD4go3v2cB5kQxc/40xOCBwBqDN/8jkz9m4z8a3mF+EQ0OP/4wxaOVf4YkIifYJk75m4xc2PsUTERbtLpPusfE7G1/iI+dPBQ0gCIMQAAA=",
                    "type": 3,
                    "matrix": "AAAAAAAA8D8AAAAAAAAAgAAAAAAAAACAINejcP1YsEAAAAAAAAAAgAAAAAAAAPA/AAAAAAAAAIAK16Nw/fy2QAAAAAAAAACAAAAAAAAAAIAAAAAAAADwPwAArkfheoS/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8="
                }
            }
        }
    ]
}

Get the object tree with selected property list whose geometry type is "ThreeJS" filtered by layer
 GET
 Resource: objects/<object_id>/disciplines/<discipline_id>/geometries/threejs

URLhttps://api-stage.bimplus.net/v2/<team_slug>/objects/<object_id>/disciplines/<discipline_id>/geometries/threejs

Examplehttps://api-stage.bimplus.net/v2/bimplus/objects/bded6990-b08b-4a27-a8bc-55c87ef2a8f8/disciplines/ac21b9a1-8853-4658-9fbf-0cf62340bd18/geometries/threejs

 Get the object tree with selected property list whose geometry type is "ThreeJS" filtered by layer.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK
{
    "elementsCount": 4,
    "faceCount": 154,
    "viewbox": {
        "x": 4067.5,
        "y": -480,
        "z": -4652.5,
        "width": 9775,
        "height": 600,
        "depth": 9695
    },
    "colors": [
        -4272966
    ],
    "objects": [
        {
            "id": "684d5deb-5ab0-419f-83dd-508755bf8b1b",
            "parent": "aa89eca9-795a-4dc9-b430-50973d0a12ce",
            "type": "WallLayer",
            "attributes": {
                "geometry": {
                    "threejs": {
                        "faces": [
                            1,
                            2,
                            1,
                            0,
                            3,
                            1,
                            5,
                            6,
                            7,
                            4,
                            1,
                            4,
                            7,
                            3,
                            0,
                            1,
                            5,
                            4,
                            0,
                            1,
                            1,
                            6,
                            5,
                            1,
                            2,
                            1,
                            7,
                            6,
                            2,
                            3
                        ],
                        "vertices": [
                            8955,
                            -780,
                            -9580,
                            -820,
                            -780,
                            -9580,
                            -820,
                            -780,
                            -9500,
                            8955,
                            -780,
                            -9500,
                            8955,
                            -180,
                            -9580,
                            -820,
                            -180,
                            -9580,
                            -820,
                            -180,
                            -9500,
                            8955,
                            -180,
                            -9500
                        ],
                        "metadata": {
                            "formatVersion": 3,
                            "colorid": 0
                        }
                    }
                },
                "quantity": {
                    "length": 9775,
                    "width": 80,
                    "height": 600,
                    "volume": 469200000.0000012,
                    "area": 5865000.000000014
                },
                "general": {
                    "name": "<PP>Wall layer"
                }
            }
        },
        {
            "id": "066c8b0a-aca0-456f-a5fc-747b8ae312e2",
            "parent": "041c2cec-09fb-49ae-9634-2998b305f2b5",
            "type": "WallLayer",
            "attributes": {
                "geometry": {
                    "threejs": {
                        "faces": [
                            1,
                            2,
                            1,
                            0,
                            3,
                            1,
                            5,
                            6,
                            7,
                            4,
                            1,
                            4,
                            7,
                            3,
                            0,
                            1,
                            5,
                            4,
                            0,
                            1,
                            1,
                            6,
                            5,
                            1,
                            2,
                            1,
                            7,
                            6,
                            2,
                            3
                        ],
                        "vertices": [
                            -820,
                            -780,
                            -9500,
                            -820,
                            -780,
                            115,
                            -740,
                            -780,
                            115,
                            -740,
                            -780,
                            -9500,
                            -820,
                            -180,
                            -9500,
                            -820,
                            -180,
                            115,
                            -740,
                            -180,
                            115,
                            -740,
                            -180,
                            -9500
                        ],
                        "metadata": {
                            "formatVersion": 3,
                            "colorid": 0
                        }
                    }
                },
                "quantity": {
                    "length": 9615,
                    "width": 80,
                    "height": 600,
                    "volume": 461520000.0000002,
                    "area": 5769000.000000003
                },
                "general": {
                    "name": "<PP>Wall layer"
                }
            }
        },
        {
            "id": "7f9314a1-1a6a-43ef-bf28-83fda655cb6b",
            "parent": "b62c83db-69ea-485b-9315-26826110e578",
            "type": "WallLayer",
            "attributes": {
                "geometry": {
                    "threejs": {
                        "faces": [
                            1,
                            2,
                            1,
                            0,
                            3,
                            1,
                            5,
                            6,
                            7,
                            4,
                            1,
                            4,
                            7,
                            3,
                            0,
                            1,
                            5,
                            4,
                            0,
                            1,
                            1,
                            6,
                            5,
                            1,
                            2,
                            1,
                            7,
                            6,
                            2,
                            3
                        ],
                        "vertices": [
                            -820,
                            -780,
                            195,
                            8875,
                            -780,
                            195,
                            8875,
                            -780,
                            115,
                            -820,
                            -780,
                            115,
                            -820,
                            -180,
                            195,
                            8875,
                            -180,
                            195,
                            8875,
                            -180,
                            115,
                            -820,
                            -180,
                            115
                        ],
                        "metadata": {
                            "formatVersion": 3,
                            "colorid": 0
                        }
                    }
                },
                "quantity": {
                    "length": 9695,
                    "width": 80,
                    "height": 600,
                    "volume": 465359999.99999976,
                    "area": 5816999.999999998
                },
                "general": {
                    "name": "<PP>Wall layer"
                }
            }
        },
        {
            "id": "4859603d-8153-4fcb-a2a4-fec3f5015dfc",
            "parent": "d1f15b9d-216a-478b-88f7-2767b5222bfe",
            "type": "WallLayer",
            "attributes": {
                "geometry": {
                    "threejs": {
                        "faces": [
                            1,
                            2,
                            1,
                            0,
                            3,
                            1,
                            5,
                            6,
                            7,
                            4,
                            1,
                            4,
                            7,
                            3,
                            0,
                            1,
                            5,
                            4,
                            0,
                            1,
                            1,
                            6,
                            5,
                            1,
                            2,
                            1,
                            7,
                            6,
                            2,
                            3
                        ],
                        "vertices": [
                            8955,
                            -780,
                            195,
                            8955,
                            -780,
                            -9500,
                            8875,
                            -780,
                            -9500,
                            8875,
                            -780,
                            195,
                            8955,
                            -180,
                            195,
                            8955,
                            -180,
                            -9500,
                            8875,
                            -180,
                            -9500,
                            8875,
                            -180,
                            195
                        ],
                        "metadata": {
                            "formatVersion": 3,
                            "colorid": 0
                        }
                    }
                },
                "quantity": {
                    "length": 9695,
                    "width": 80,
                    "height": 600,
                    "volume": 465360000.00000006,
                    "area": 5817000
                },
                "general": {
                    "name": "<PP>Wall layer"
                }
            }
        }
    ]
}

Get the object tree whose geometry type is "compressed geometry mesh (meshblob)" filtered by layer
 GET
 Resource: objects/<object_id>/disciplines/<discipline_id>/geometries/meshblob 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/objects/<object_id>/disciplines/<discipline_id>/geometries/meshblob

Examplehttps://api-stage.bimplus.net/v2/bimplus/objects/bded6990-b08b-4a27-a8bc-55c87ef2a8f8/disciplines/ac21b9a1-8853-4658-9fbf-0cf62340bd18/geometries/meshblob

 Get the object tree whose geometry type is "compressed geometry mesh (meshblob)" filtered by layer.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK
{
    "elementsCount": 4,
    "objects": [
        {
            "id": "684d5deb-5ab0-419f-83dd-508755bf8b1b",
            "parent": "aa89eca9-795a-4dc9-b430-50973d0a12ce",
            "type": "WallLayer",
            "attributes": {
                "geometry": {
                    "compress": true,
                    "picture": "H4sIAAAAAAAEANVX624TRxTe2Yu9TkocIIQ7mDSXtpgljh0gldIGXBqhRsiCwJ/Imq7XQ9hmvaZ7QXUqFbXqg7Tq/z5DpT5Ef/cdeuXSdr7tjNkaOazURIGN5tucM2fnfOfsOTNrhSiK8je/cMf1hsrhTqNxNYoCt9VwnSgO2HrvAauWS3dZELpdf3lhvlKx5q3alUuLVqVaW+JT9diD4bLP4iiwvXKpEbc81/mI9da7W8xf9mPPM+CjfJN1WBQ699mWdfNO5Hprbiuwg55Vv2aH7LrHZ/2o0fV6rM2CPH/AeNB1/Uhn7U2m37MdZnboLbvtxuFYh15jftv1N4Ou5zE94iTVGx9omqbruvYtud0LI9ax6ph0Is47tFaZzwLXsdbcMPq4srExlEufB3fNY9mLbDSb3+wGxes8L682ww/5S9szhlNDvXdjP7oaBHYPBZ3RbHqYmSxI0IbhqMjLauy2IRc0gA4wADkOI8afvK8yLYnGyD+0vZhRqphYUBtXFP0P/nza0yifUKmt0pZKHZW2VcpUek+lmyq9r1JXpZ+odEt5fpn5vCouZeDSQfg16BHQzFGXkwwNGrrbzKQP/12TJ3suE7eNJqI3zUIBNzF0vKtXvwF3DH82C7V+9CPY3MXQjd2Kfk+b+/9FD2r96NE6OTGMXPYdodChiYIF/Ny5iw4NNe2LDIkTJjf8qLpQLnVCpxt4but5Umo8I/zv5aloXb5sLzqLlypL1Rqbv7LUbD7K7v42Px09tsv+k7ygjAoHsG+hrRQi+2omU08mS4wBioBxwEHAIcBhwATgCByMSAcw04duqOmqT9afBBwFHAMcB5wAnAScApwGnAGcBZQA5zgc0POj/wnrpV5RbYnXKcCbgGnADGAWMId1VR2J2+cCGt5XeTSLWXgLIcuBl7zfJbcj41HO+O0UYwOFla0OsS75jPTINhzkcniDn098v/rl0R9XPl0e+ek7ZX0F8s/bX79PUKpjwgCKFwzGBwwG7+RgygAuXjA4NGAgXWB64oevVsjhIRz6BhNDOPQNjgzhIA2MyZ0+hAabzGixTdfX+Hc4KkcVbwBtQ9B5k0LABDkmFMn3DRTHhUKTj50QCkO0HTkpFBDwY4CcEoq82MvJaaHIicfImZTbRHE25TZ5pJRymyx6Tih04cmYypICdHziBD9Nwv0+FJK95x1Eg70n2YTOQ5qWUhnSjJQuQJqVkgVpTkoXORTlFmDix+FffDzj4ykfRdlqfIN8r64oa3y8y8ejOoH75FyYT3UjOS+1lbS2LLULae0Fqa2mtZbU1tLai1K7mNIWpWtTlp0srqJ0bxqiEPLidRclhSRWLPmE339HrJKGiQzgoMMn+W+YkVRM5AUnFD72f8WMpGMiWzhFHvP7L/j/H73mm6ltDwAA",
                    "type": 3,
                    "matrix": "AAAAAAAA8D8AAAAAAAAAgAAAAAAAAACAAEfhehSgicAAAAAAAAAAgAAAAAAAAPA/AAAAAAAAAICF61G4/o3CQAAAAAAAAACAAAAAAAAAAIAAAAAAAADwP65H4XoUYIjAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8="
                }
            }
        },
        {
            "id": "066c8b0a-aca0-456f-a5fc-747b8ae312e2",
            "parent": "041c2cec-09fb-49ae-9634-2998b305f2b5",
            "type": "WallLayer",
            "attributes": {
                "geometry": {
                    "compress": true,
                    "picture": "H4sIAAAAAAAEANVXW28TRxTe2Yu9TiAOEFLumDSXtpgljh0gSGkDhkaoEbJK4CWypuv1ELZZr+leUJ1KoFb9IUW88xuqvvQn9Ln/ofcbnW87Y5YUh5WaKHSj+SbnzNk535w5Z2atEEVRnvEHPZ59KofbjcaVKArcVsN1ojhgq737rFou3WFB6Hb9xbnZSsWatWqXLsxblWptgQ/VYw+Giz6Lo8D2yqVG3PJc5wPWW+1uMH/Rjz3PgI/yTdZhUejcYxvWzduR6624rcAOelb9qh2y6x4f9aNG1+uxNgvy/AXjftf1I52115l+13aY2aEf2m03Dkc69Crz266/HnQ9j+kRJ6neuKZpmq7r2mNyqxdGrGPVMehEnHdoLTOfBa5jrbhh9FFlbW0glz4P7pqvZTei0Wx+tRMUr/O4vN4M3+ebtmsMJwZ678Z+dCUI7B4SOqPZ5CAzmZCgDcNhEZfl2G1DLmgAHWAAchyGjF95XWWaEoWRf2B7MaNUMTGhNqoo+i/8/bSnYT6gUlulLZU6Km2rlKn0rkrXVXpPpa5KP1bphvL8MfN5VTzKlkcH4f9BjYBmjrqcZGjQ0N1kJn3wz5w82DOZuK01sXrTLBTQiaZjr17/Atx2+dNZqPVXP4TDXTTd2KnV72px/7fVg1p/9SidnGhGLvuJUOjQRMECfu/cQYWGmvYwQ+CEyQ0/qs6VS53Q6Qae23oelBqPCP97dShaFy/a8878hcpCtcZmLy00m4+yu7/Fb0eP7bD/JC5Io8J+nFsoK4XIuprKVJPJFCOAImAUcABwEHAIMAY4DAdD0gHM9IEHajrrk/nHAW8AjgCOAo4BjgNOAE4CTgFOA0qAMxz26/nhF5b1Sq/ItsTrBOBNwCRgCjANmMG8qo7A7XECDa6rPIrFLLyFJcuGTd7rlNuW8TBn/HaKsYHEypaHmJd8SnpkEw5yOezgZ2NPl7/f/PI99J9/+82SlAlSdWSLQbono8Lgk8Wh754oq0v/MjjwEoMXXBx8iQsYQBr7+oslcmgAh77B2AAOfYPDAzhIA2N8uw+hrUVmtNi662v8OxyZo4odQNkQVN64EDBAjghF8n0DxVGh0ORrx4TCEGVHjgsFBPwYICeEIi/OcnJSKHLiNXIq5TZRnE65TV4ppdwmk54RCl14MiayhAAVnzjBT5Nwry+F5Ox5B6vB2ZMcQmchTUqpDGlKSucgTUvJgjQjpfMcivIIMPHj8C/e/uTtD96KstT4AfluXVFWeLvM26M6gfvkXphNVSM5K7WVtLYstXNp7Tmpraa1ltTW0trzUjuf0hala1OmnUyuonRvGiIR8mK7i5JCslZM+Tvvf8ZaJQ0TEcBFh0/ynzAiqZiIC24ofOz/iBFJx0S0cIv8xvsf8P/f/WbD220PAAA=",
                    "type": 3,
                    "matrix": "AAAAAAAA8D8AAAAAAAAAgAAAAAAAAACA/kbhehSgicAAAAAAAAAAgAAAAAAAAPA/AAAAAAAAAIAAPwrXo8BcwAAAAAAAAACAAAAAAAAAAIAAAAAAAADwP65H4XoUYIjAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8="
                }
            }
        },
        {
            "id": "7f9314a1-1a6a-43ef-bf28-83fda655cb6b",
            "parent": "b62c83db-69ea-485b-9315-26826110e578",
            "type": "WallLayer",
            "attributes": {
                "geometry": {
                    "compress": true,
                    "picture": "H4sIAAAAAAAEANVXW28TRxTe2Yu9TkocIIQ7mJBLC2aJYwdIpbSASyNEhKwSeIms6Xo9hCXrNewF1alU1Ko/pFXf+xuq/ok+9xf0pff7fMuMWYwcVmqi0I3mm8yZs3O+c+acmbVCFEX5hz/o8byhcrjbaFyLosBtNVwnigO21nvEquXSPRaEbtdfXpivVKx5q3bl0qJVqdaW+FQ99qC47LM4CmyvXGrELc91brHeWneT+ct+7HkGbJRvsw6LQucB27Ru341cb9VtBXbQs+rX7ZDd8PisHzW6Xo+1WZDnLxiPuq4f6ay9wfT7tsPMDv3AbrtxONah15nfdv2NoOt5TI84SfXme5qm6bqufUnu9MKIdaw6Jp2I8w6tFeazwHWsVTeMPqysrw/l0ufBTXNfdiMazeYXO0HxBo/L683wfb5pu8Zwaqj1buxH14LA7iGhM6pND1OTCQnaUBwVcVmJ3TbGBQ2gAwxAjsOI8Ruvq0xLojDyT2wvZpQqJhbUxhVF/5W/n7Y0yidUaqu0pVJHpW2VMpXeV+mGSh+o1FXpQ5VuKs8fM59XxaMMPDoI/w9qBDRz1OUkQ4OG7hYz6ZNna/Jgz2Xitt6E96ZZKKATTcdevf4FuK37s1mo9b0fweEumm7slPe7Wtz/zXtQ63uP0smJZuSynwiFDk0ELOD3zj1UaKhpn2QInFC56UfVhXKpEzrdwHNbz4NS4xHhf68ORevyZXvRWbxUWarW2PyVpWbzaXbzd/jt6LEdtp/EBWlU2IdzC2WlEFlXM5lqMlliDFAEjAP2Aw4ADgImAIdgYEQagJo+9EBNZ32y/iTgMOAI4CjgGOA44ATgJOAU4DSgBDjDYZ+eH33BrVdaRbYlVqcAZwHTgBnALGAO66o6ArfHCTS8rvIoFrPwJlyWDZu81ym3LeNRzvitFGMDiZUtD7Eu+Yj0yBYM5HLYwY8nvl75fuvzdwd7glQdEwqf/vDt1ZcUxgcUHi+PfPeVstZXJPtTChC8pHBgQEH2wIlvPrtKDg7h0FeYGMKhr3BoCAepYExu9yE0WGRGi224vsa/w5E5qtgBlA1B5U2KASbIESFIvm8gOCoEmnztmBAYouzIcSHAAD8GyAkhyIuznJwUgpx4jZxKmU0Ep1Nmk1dKKbPJomeEQBeWjKksIUDFJ0bw0yTc60shOXvOwRucPckhdB6jaTkqYzQjRxcwmpUjC6M5ObrIoSiPABM/Dv/m7S/e/uStKEuNH5Dv1BVllbe3eXtaJzCf3AvzqWok56W0kpaWpXQhLb0gpdW01JLSWlp6UUoXU9KiNG3KtJPJVZTmTUMkQl5sd1FSSHzFkn/w/hf4KmmYiAAuOnyS/4wZScVEXHBD4WP/J8xIOiaihVvkd97/iP//BRHHAGFtDwAA",
                    "type": 3,
                    "matrix": "AAAAAAAA8D8AAAAAAAAAgAAAAAAAAACAAEfhehSgicAAAAAAAAAAgAAAAAAAAPA/AAAAAAAAAIB5H4XrUWBowAAAAAAAAACAAAAAAAAAAIAAAAAAAADwP65H4XoUYIjAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8="
                }
            }
        },
        {
            "id": "4859603d-8153-4fcb-a2a4-fec3f5015dfc",
            "parent": "d1f15b9d-216a-478b-88f7-2767b5222bfe",
            "type": "WallLayer",
            "attributes": {
                "geometry": {
                    "compress": true,
                    "picture": "H4sIAAAAAAAEANVXW28TRxTeq71OShwghDuYNJcWzBLHDpBKaQGXRqgRskrgJbKm6/UQhqzXsBdUp1JRq/6QVn3vb6j6J/rcX9CXtrTQFubbzphNhMNKTRS60XybOXNmznfOnDOzVlRFUZ7zB288b2kcbjcaV6MoYK0Gc6M4oCu9B7RaLt2hQci6/uLcbKViz9q1yxfn7Uq1tsCH6rEHxUWfxlHgeOVSI255zP2Y9la669Rf9GPPM2GjfJN2aBS69+i6ffN2xLxl1gqcoGfXrzkhve7xUT9qdL0ebdMgzyeYD7rMjwzaXqPGXcelVod84rRZHI50yDXqt5m/FnQ9jxoRJ6nd+FDXdcMw9G/VW70woh27jkE34rxDe4n6NGCuvczC6NPK6upALn0e3DT3ZTei0Wx+sxMUr/O4vNkMP+KbtmsMJwZa78Z+dDUInB4SOqPa5CA1mZCgDcVhEZelmLXRL+gAA2ACchyGzD95XWVaEoWRf+R4MSVEsbCgPqooxh98ftrSMB/QiKORlkZcjbQ1QjVyVyNrGrmnEaaR+xpZV14+Vj6viUfZ8hgg/D+oEdDMEcZJhiYJ2Qa1yKN/1+TBnsnEbbUJ7y2rUMBLNAN79eYX4LbuT2eh1vd+CIe7aIa5U97vanH/N+9Bre89SicnmpnLfiIUOiQR0IDfO3dQoaGuf5EhcELlhh9V58qlTuh2A4+1XgalxiPC/14fitalS868O3+xslCt0dnLC83m4+zmb/Hb0aM7bD+JC9KosA/nFspKUWVdTWWqyWSJEUARMArYDzgAOAgYAxyCgSFpAGrGwAM1nfXJ+uOAw4AjgKOAY4DjgBOAk4BTgNOAEuAMh31GfniTW6+1imxLrE4A3gZMAqYA04AZrKsZCNweJ9DgusqjWKzCO3BZNmzyXqfctoyHOeN3U4xNJFa2PMS66mdqT92AgVwOO/hwcein75SVK5+Pfb/088bXH8i3ilQd2aLw5S8/9hXVUaGQnrlJYf8rFDaZOPAKExgAjv3w1RX14AAOfYWxARz6CocGcJAK5vh2H0Jbi8xs0TXm6/w7HJmjiR1A2aiovHHRwYB6RAiS7xsIjgqBLqcdEwJTlJ16XAjQwY8B9YQQ5MVZrp4UgpyYpp5KmU0Ep1NmkymllNlk0TNCYAhL5kSWEKDiEyP4aRLu9aWQnD1n4Q3OnuQQOofepOyV0ZuSvfPoTcuejd6M7F3gUJRHgIUfh//w9jdvf/FWlKXGD8j364qyzNt7vD2uqzCf3AuzqWpUz0lpJS0tS+lcWnpeSqtpqS2ltbT0gpTOp6RFadqSaSeTqyjNW6ZIhLzY7qKkkPiKJZ/x9xP4KmlYiAAuOnyS/44RScVCXHBD4WP/N4xIOhaihVvkKX//iv9fAChNaqptDwAA",
                    "type": 3,
                    "matrix": "AAAAAAAA8D8AAAAAAAAAgAAAAAAAAACAkOtRuH5VwUAAAAAAAAAAgAAAAAAAAPA/AAAAAAAAAIDAHoXrUWBowAAAAAAAAACAAAAAAAAAAIAAAAAAAADwP65H4XoUYIjAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8="
                }
            }
        }
    ]
}
Get the different properties / structure(normal, viewer properties, object in hierarchical tree structure) of the object using different property combinations
 GET

Resource: objects/<object_id>/geometries/threejs/properties/{props} 

where props can be 1, 2 or 3.
/geometries/threejs/properties/1 : show objects as hierarchical tree ( default (/geometries/threejs or /geometries/threejs/properties/0 will give the object details in a flat structure))
/geometries/threejs/properties/2 : show also viewer attributes
/geometries/threejs/properties/3 : include FACE_NORMAL

URLhttps://api-stage.bimplus.net/v2/<team_slug>/objects/<object_id>/geometries/threejs/properties/{props}

Examplehttps://api-stage.bimplus.net/v2/bimplus/objects/a17ff78a-8b42-4523-9bf7-283e725e3e95/geometries/threejs/properties/7 (i.e 7 gives you a combination of objects as tree(1) + viewer attributes(2) + face normal(3))

Get the different properties / structure (normal, viewer properties, object in hierarchical tree structure) of the object using different property combinations.

url: /geometries/threejs/properties/{props}

where props can be 1, 2 or 3.
/geometries/threejs/properties/1 : show objects as hierarchical tree ( default (/geometries/threejs or /geometries/threejs/properties/0 will give the object details in a flat structure))
/geometries/threejs/properties/2 : show also viewer attributes
/geometries/threejs/properties/3 : include FACE_NORMAL

You can also combine different property numbers

eg: geometries/threejs/properties/4 should give both the show objects as tree(1) + add FACE_NORMAL in threeJs json(3)

geometries/threejs/properties/7 should give you a combination of objects as tree(1) + viewer attributes(2) + face normal(3)

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK
{
    "elementsCount": 1,
    "faceCount": 88,
    "viewbox": {
        "x": 21000,
        "y": 2850,
        "z": -19000,
        "width": 133,
        "height": 5700,
        "depth": 140
    },
    "colors": [
        4278190080
    ],
    "objects": [
        {
            "id": "a17ff78a-8b42-4523-9bf7-283e725e3e95",
            "type": "Column",
            "attributes": {
                "geometry": {
                    "threejs": {
                        "faces": [
                            0,
                            2,
                            1,
                            0,
                            0,
                            4,
                            0,
                            3,
                            0,
                            7,
                            6,
                            5,
                            0,
                            8,
                            5,
                            6,
                            0,
                            9,
                            5,
                            8,
                            0,
                            10,
                            9,
                            8,
                            0,
                            13,
                            12,
                            11,
                            0,
                            16,
                            15,
                            14,
                            0,
                            17,
                            14,
                            15,
                            0,
                            18,
                            14,
                            17,
                            0,
                            19,
                            18,
                            17,
                            0,
                            7,
                            15,
                            6,
                            0,
                            16,
                            6,
                            15,
                            0,
                            7,
                            5,
                            15,
                            0,
                            17,
                            15,
                            5,
                            0,
                            17,
                            5,
                            19,
                            0,
                            9,
                            19,
                            5,
                            0,
                            2,
                            11,
                            1,
                            0,
                            2,
                            0,
                            11,
                            0,
                            13,
                            11,
                            0,
                            0,
                            13,
                            0,
                            12,
                            0,
                            4,
                            12,
                            0,
                            0,
                            4,
                            3,
                            12,
                            0,
                            20,
                            12,
                            3,
                            0,
                            18,
                            10,
                            14,
                            0,
                            8,
                            14,
                            10,
                            0,
                            8,
                            6,
                            14,
                            0,
                            16,
                            14,
                            6,
                            0,
                            0,
                            1,
                            21,
                            0,
                            21,
                            3,
                            0,
                            0,
                            1,
                            11,
                            22,
                            0,
                            22,
                            11,
                            12,
                            0,
                            12,
                            20,
                            23,
                            0,
                            3,
                            21,
                            23,
                            0,
                            23,
                            22,
                            12,
                            0,
                            23,
                            20,
                            3,
                            0,
                            26,
                            25,
                            24,
                            0,
                            24,
                            27,
                            26,
                            0,
                            25,
                            26,
                            28,
                            0,
                            31,
                            30,
                            29,
                            0,
                            32,
                            31,
                            29,
                            0,
                            35,
                            34,
                            33,
                            0,
                            32,
                            29,
                            36,
                            0,
                            38,
                            36,
                            37,
                            0,
                            36,
                            38,
                            32,
                            0,
                            39,
                            10,
                            18,
                            0,
                            24,
                            41,
                            40,
                            0,
                            42,
                            19,
                            9,
                            0,
                            43,
                            30,
                            37,
                            0,
                            36,
                            26,
                            27,
                            0,
                            37,
                            27,
                            43,
                            0,
                            27,
                            37,
                            36,
                            0,
                            26,
                            36,
                            29,
                            0,
                            30,
                            43,
                            28,
                            0,
                            29,
                            28,
                            26,
                            0,
                            28,
                            29,
                            30,
                            0,
                            24,
                            40,
                            43,
                            0,
                            43,
                            27,
                            24,
                            0,
                            33,
                            34,
                            39,
                            0,
                            39,
                            34,
                            44,
                            0,
                            45,
                            34,
                            35,
                            0,
                            38,
                            23,
                            21,
                            0,
                            21,
                            32,
                            38,
                            0,
                            21,
                            1,
                            31,
                            0,
                            31,
                            1,
                            22,
                            0,
                            31,
                            32,
                            21,
                            0,
                            45,
                            35,
                            25,
                            0,
                            24,
                            25,
                            35,
                            0,
                            41,
                            24,
                            35,
                            0,
                            33,
                            39,
                            18,
                            0,
                            42,
                            33,
                            18,
                            0,
                            18,
                            19,
                            42,
                            0,
                            45,
                            40,
                            44,
                            0,
                            44,
                            34,
                            45,
                            0,
                            44,
                            40,
                            41,
                            0,
                            35,
                            33,
                            42,
                            0,
                            41,
                            42,
                            44,
                            0,
                            42,
                            41,
                            35,
                            0,
                            38,
                            37,
                            22,
                            0,
                            31,
                            22,
                            37,
                            0,
                            22,
                            23,
                            38,
                            0,
                            37,
                            30,
                            31,
                            0,
                            44,
                            42,
                            9,
                            0,
                            39,
                            44,
                            9,
                            0,
                            9,
                            10,
                            39,
                            0,
                            45,
                            25,
                            28,
                            0,
                            40,
                            45,
                            28,
                            0,
                            28,
                            43,
                            40
                        ],
                        "vertices": [
                            21066.5,
                            0,
                            -18930,
                            21058,
                            0,
                            -18985.2,
                            21058,
                            0,
                            -18930,
                            21058,
                            0,
                            -19070,
                            21066.5,
                            0,
                            -19070,
                            20942,
                            0,
                            -18930,
                            20933.5,
                            0,
                            -19070,
                            20933.5,
                            0,
                            -18930,
                            20942,
                            0,
                            -19070,
                            20942,
                            0,
                            -18985.2,
                            20942,
                            0,
                            -19014.8,
                            21058,
                            5700,
                            -18930,
                            21066.5,
                            5700,
                            -19070,
                            21066.5,
                            5700,
                            -18930,
                            20942,
                            5700,
                            -19070,
                            20933.5,
                            5700,
                            -18930,
                            20933.5,
                            5700,
                            -19070,
                            20942,
                            5700,
                            -18930,
                            20942,
                            5700,
                            -19014.8,
                            20942,
                            5700,
                            -18985.2,
                            21058,
                            5700,
                            -19070,
                            21057.8,
                            0,
                            -19012.4,
                            21057.8,
                            5700,
                            -18987.6,
                            21057.8,
                            5700,
                            -19012.4,
                            20954,
                            5700,
                            -18997.2,
                            20954,
                            5700,
                            -19002.8,
                            21048.3,
                            5700,
                            -19003,
                            21048.3,
                            5700,
                            -18997,
                            21048.3,
                            0,
                            -19003,
                            21052.7,
                            0,
                            -19004.8,
                            21052.7,
                            0,
                            -18995.2,
                            21056,
                            0,
                            -18991.9,
                            21056,
                            0,
                            -19008.1,
                            20944,
                            5700,
                            -19008.1,
                            20945.5,
                            0,
                            -19006.3,
                            20947.3,
                            5700,
                            -19004.8,
                            21052.7,
                            5700,
                            -19004.8,
                            21052.7,
                            5700,
                            -18995.2,
                            21056,
                            5700,
                            -19008.1,
                            20942.9,
                            0,
                            -19010.2,
                            20951.7,
                            0,
                            -18997,
                            20949.4,
                            5700,
                            -18996.3,
                            20942.9,
                            5700,
                            -18989.8,
                            21048.3,
                            0,
                            -18997,
                            20945.5,
                            0,
                            -18993.7,
                            20949.4,
                            0,
                            -19003.7
                        ],
                        "metadata": {
                            "formatVersion": 3,
                            "colorid": 0
                        }
                    }
                },
                "general": {
                    "name": "B132",
                    "description": "Ifc Imported Element"
                },
                "element": {
                    "elementtyp": "Column",
                    "layer": "BuildingModel",
                    "model": "Structural model",
                    "material": "S 235"
                },
                "elementstate": {
                    "state": "Nothing Defined"
                },
                "allfreeattrib": {
                    "globalid": "26gojRHan8_9KtPcvJkUQf",
                    "skipparentlocations": "False",
                    "extrudeprofilename": "HEA140",
                    "extrudeprofiletype": "IShapeProfile",
                    "filletradius": "12",
                    "flangethickness": "8,5",
                    "overalldepth": "133",
                    "overallwidth": "140",
                    "webthickness": "5,5"
                }
            }
        }
    ]
}

Update the object
 PUT
 Resource: objects/<object_id> 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/objects/<object_id>

Examplehttps://api-stage.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

 Update or replace a specified existing object with a new one.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/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]}"
        }
    }
}
Status: 200 OK

Create a new comment in the object
 POST
 

Resource: objects/<object_id>/comments 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/objects/<object_id>/comments

Examplehttps://api-stage.bimplus.net/v2//objects/cb96a9b1-48c9-4d97-8c9e-262476c1c6b2/comments

JSON Structure:

Name

Mandatory / Optional

Type

Description

issueIdwill be ignoredstring(guid)The id of the issue

text

mandatory

string

The comment text

createdAt

will be ignored

string (date)

Creation date of the comment

modifiedAtwill be ignoredstring (date)Modified date of the comment

author

will be ignored

object

The author of the comment

Create a new comment for a specified object.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
{
    "text": "The fire exit should be x:120, y: 120; z: 340"
}
Status: 201 Created
{
    "issueId": "cb96a9b1-48c9-4d97-8c9e-262476c1c6b2",
    "text": "The fire exit should be x:120, y: 120; z: 340",
    "createdAt": "2013-07-02T13:26:18.8932853+00:00",
    "author": {
        "id": "00000000-0000-0000-0000-000000000000",
        "email": "",
        "firstname": "Unknown",
        "lastname": "User",
        "company": "",
        "fullname": "Unknown User",
        "displayname": "Unknown User",
        "info": "",
        "gender": "",
        "phoneWork": "",
        "phoneHome": "",
        "fax": "",
        "mobile": "",
        "birthDate": "0000-00-00",
        "address": {
            "street": "",
            "streetNr": "",
            "zip": "",
            "city": "",
            "country": ""
        },
        "preferedLanguage": null
    },
    "id": "d258c905-c8af-4463-b0d8-ac09dbcfc255"
}

Get all the comments of the object
 Get all the comments of a specified object.
 GET
 Resource: objects/<object_id>/comments 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/objects/<object_id>/comments

Examplehttps://api-stage.bimplus.net/v2/objects/cb96a9b1-48c9-4d97-8c9e-262476c1c6b2/comments

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK
[
    {
        "issueId": "cb96a9b1-48c9-4d97-8c9e-262476c1c6b2",
        "text": "The fire exit should be x:120, y: 120; z: 340",
        "createdAt": "2013-07-02T13:26:18+00:00",
        "modifiedAt": "2013-07-03T13:26:18+00:00",
        "author": {
        "id": "00000000-0000-0000-0000-000000000000",
        "email": "",
        "firstname": "Unknown",
        "lastname": "User",
        "company": "",
        "fullname": "Unknown User",
        "displayname": "Unknown User",
        "info": "",
        "gender": "",
        "phoneWork": "",
        "phoneHome": "",
        "fax": "",
        "mobile": "",
        "birthDate": "0000-00-00",
        "address": {
            "street": "",
            "streetNr": "",
            "zip": "",
            "city": "",
            "country": ""
        },
        "preferedLanguage": null
    },
        "id": "d258c905-c8af-4463-b0d8-ac09dbcfc255"
    }
]

Delete all the comments of the object
 DELETE
 Resource: objects/<object_id>/comments

URLhttps://api-stage.bimplus.net/v2/<team_slug>/objects/<object_id>/comments

Examplehttps://api-stage.bimplus.net/v2/objects/cb96a9b1-48c9-4d97-8c9e-262476c1c6b2/comments

 Delete all the comments from the issue.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK

Create a new attachment in the object
 POST
 Resource: objects/<object_id>attachments 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/objects/<object_id>attachments

Examplehttps://api-stage.bimplus.net/v2/bimplus/objects/7cf910cb-e357-43f6-aa3a-b45c26380f75/attachments

JSON Structure: Please note that all the information required for this call will be taken from the document that you attach and hence the request of this call has no body.

Name

Mandatory / Optional

Type

Description

objectIds

will be ignored

string

The id of the project objects to which the file has to be attached

fileName

will be ignored

string

Name of the file to be attached to the project

type

will be ignored

string

Mime type

size

will be ignored

integer

Size of the file to be attached to the project

createdAtwill be ignoredstringCreation date of the attachment
creatorwill be ignoredobjectThe user who created the attachment
Create a new attachment in a object.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: multipart/form-data
Status: 201 Created
    {
        "objectIds": [
            "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
        ],
        "fileName": "Building_Plan.jpg",
        "type": "image/jpeg",
        "size": 211258,
        "createdAt": "2013-12-11T10:47:39",
        "creator": {
        "id": "e18941f4-a809-2d01-d27d-cd251f2b6cb6",
        "email": "test@bimplus.net",
        "firstname": "First Name",
        "lastname": "Second Name",
        "company": "Best-Company",
        "fullname": "First Name Second Name",
        "displayname": "Best-Company",
        "info": "",
        "gender": "",
        "phoneWork": "",
        "phoneHome": "",
        "fax": "",
        "mobile": "",
        "birthDate": "0000-00-00",
        "address": {
            "street": "Westermeier str.",
            "streetNr": "10",
            "zip": "81829",
            "city": "München",
            "country": "Germany"
        },
        "preferedLanguage": "en"
       },
        "id": "6cea110a-88f4-43ac-9a00-ebaf677be333"
    }

Get the attachment list from the object
 GET
 Resource: objects/<object_id>attachments 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/objects/<object_id>attachments

Examplehttps://api-stage.bimplus.net/v2/bimplus/objects/7cf910cb-e357-43f6-aa3a-b45c26380f75/attachments

 Get all the attachments belonging to a specified object.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK
    {
        "objectIds": [
            "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
        ],
        "fileName": "Building_Plan.jpg",
        "type": "image/jpeg",
        "size": 211258,
        "createdAt": "2013-12-11T10:47:39",
        "creator": {
        "id": "e18941f4-a809-2d01-d27d-cd251f2b6cb6",
        "email": "test@bimplus.net",
        "firstname": "First Name",
        "lastname": "Second Name",
        "company": "Best-Company",
        "fullname": "First Name Second Name",
        "displayname": "Best-Company",
        "info": "",
        "gender": "",
        "phoneWork": "",
        "phoneHome": "",
        "fax": "",
        "mobile": "",
        "birthDate": "0000-00-00",
        "address": {
            "street": "Westermeier str.",
            "streetNr": "10",
            "zip": "81829",
            "city": "München",
            "country": "Germany"
        },
        "preferedLanguage": "en"
       },
        "id": "6cea110a-88f4-43ac-9a00-ebaf677be333"
    }

Delete all the attachments from the object
 DELETE
 Resource: objects/<object_id>/attachments 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/objects/<object_id>/attachments

Examplehttps://api-stage.bimplus.net/v2/bimplus/objects/7cf910cb-e357-43f6-aa3a-b45c26380f75/attachments

 Delete all the attachments from a specified object.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK

Create a new attachment in the object
 POST
 Resource: objects/<object_id>attachments 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/objects/<object_id>attachments

Examplehttps://api-stage.bimplus.net/v2/bimplus/objects/7cf910cb-e357-43f6-aa3a-b45c26380f75/attachments

JSON Structure: Please note that all the information required for this call will be taken from the document that you attach and hence the request of this call has no body.

Name

Mandatory / Optional

Type

Description

objectIds

will be ignored

string

The id of the project objects to which the file has to be attached

fileName

will be ignored

string

Name of the file to be attached to the project

type

will be ignored

string

Mime type

size

will be ignored

integer

Size of the file to be attached to the project

createdAtwill be ignoredstringCreation date of the attachment
creatorwill be ignoredobjectThe user who created the attachment
Create a new attachment in a object.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: multipart/form-data
Status: 201 Created
    {
        "objectIds": [
            "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
        ],
        "fileName": "Building_Plan.jpg",
        "type": "image/jpeg",
        "size": 211258,
        "createdAt": "2013-12-11T10:47:39",
        "creator": {
        "id": "e18941f4-a809-2d01-d27d-cd251f2b6cb6",
        "email": "test@bimplus.net",
        "firstname": "First Name",
        "lastname": "Second Name",
        "company": "Best-Company",
        "fullname": "First Name Second Name",
        "displayname": "Best-Company",
        "info": "",
        "gender": "",
        "phoneWork": "",
        "phoneHome": "",
        "fax": "",
        "mobile": "",
        "birthDate": "0000-00-00",
        "address": {
            "street": "Westermeier str.",
            "streetNr": "10",
            "zip": "81829",
            "city": "München",
            "country": "Germany"
        },
        "preferedLanguage": "en"
       },
        "id": "6cea110a-88f4-43ac-9a00-ebaf677be333"
    }

Get the attachment list from the object
 GET
 Resource: objects/<object_id>attachments 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/objects/<object_id>attachments

Examplehttps://api-stage.bimplus.net/v2/bimplus/objects/7cf910cb-e357-43f6-aa3a-b45c26380f75/attachments

 Get all the attachments belonging to a specified object.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK
    {
        "objectIds": [
            "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
        ],
        "fileName": "Building_Plan.jpg",
        "type": "image/jpeg",
        "size": 211258,
        "createdAt": "2013-12-11T10:47:39",
        "creator": {
        "id": "e18941f4-a809-2d01-d27d-cd251f2b6cb6",
        "email": "test@bimplus.net",
        "firstname": "First Name",
        "lastname": "Second Name",
        "company": "Best-Company",
        "fullname": "First Name Second Name",
        "displayname": "Best-Company",
        "info": "",
        "gender": "",
        "phoneWork": "",
        "phoneHome": "",
        "fax": "",
        "mobile": "",
        "birthDate": "0000-00-00",
        "address": {
            "street": "Westermeier str.",
            "streetNr": "10",
            "zip": "81829",
            "city": "München",
            "country": "Germany"
        },
        "preferedLanguage": "en"
       },
        "id": "6cea110a-88f4-43ac-9a00-ebaf677be333"
    }

Delete all the attachments from the object
 DELETE
 Resource: objects/<object_id>/attachments 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/objects/<object_id>/attachments

Examplehttps://api-stage.bimplus.net/v2/bimplus/objects/7cf910cb-e357-43f6-aa3a-b45c26380f75/attachments

 Delete all the attachments from a specified object.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK

Delete the object
 DELETE
 Resource: objects/<object_id> 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/objects/<object_id>

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

 Deletes a specified object.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
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"
}

ElementType Service


Element type describes the type of predefined building elements required to build a building (eg: wall, window, door etc) Each element type have an unique id. Please see the detailed structure of the ElementType in the Object Model

The available element types can be found under 2.1.4.1 Bimplus Element Types

Get the element types
 GET
 Resource: element-types 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/element-types

Examplehttps://api-stage.bimplus.net/v2/bimplus/element-types

 Gets the list of existing element types.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK
[3]
0:  [3]
0:  {
type: "GeometryObject"
category: "/1/30/4/"
name: "3D object"
ifcType: "ID_IFCBuildingElementProxy"
id: "5a8a8670-cb9f-4f04-a467-04a9e416a6d0"
}-
1:  {
type: "Chimney"
category: "/1/10/8/"
name: "Chimney"
ifcType: "ID_IFCBuildingElementProxy"
id: "e504f24c-e643-452b-b901-6a18883dc7e9"
}-
2:  {
type: "Column"
category: "/1/10/2/"
name: "Column"
ifcType: "ID_IFCColumn"
id: "2e308afe-d078-4c20-b53c-76b2da66d848"
}
...

Get the element type properties
 GET
 Resource: element-types/<element_type_id> 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/element-types/<element_id>

Examplehttps://api-stage.bimplus.net/v2/bimplus/element-types/e504f24c-e643-452b-b901-6a18883dc7e9

 Get the properties of a specified element type.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK
{
type: "Chimney"
category: "/1/10/8/"
name: "Chimney"
ifcType: "ID_IFCBuildingElementProxy"
id: "e504f24c-e643-452b-b901-6a18883dc7e9"
}

Get the list of existing layers
 GET
 Resource: element-types/disciplines 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/element-types/disciplines

Examplehttps://api-stage.bimplus.net/v2/bimplus/element-types/disciplines

 Gets the list of existing layers.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK
{
-e79a4e18-383f-49c4-aabf-e15b27850423: {
category: "/14/"
name: "Airconditionermodel"
ifcType: null
id: "e79a4e18-383f-49c4-aabf-e15b27850423"
}
-63b069d2-81df-4418-91de-8a954fa12924: {
category: "/5/"
name: "Wood Construction Model"
ifcType: null
id: "63b069d2-81df-4418-91de-8a954fa12924"
}
-dd5cc7d0-72fe-46aa-ba62-dcd86729bd2f: {
category: "/4/"
name: "Massiveconstructionmodel"
ifcType: null
id: "dd5cc7d0-72fe-46aa-ba62-dcd86729bd2f"
}
-6a6e4d09-3550-4483-8134-98ac1e6c1afb: {
category: "/60/"
name: "Production model"
ifcType: null
id: "6a6e4d09-3550-4483-8134-98ac1e6c1afb"
}
-09e623d4-1e12-4a77-b358-ea1d0b28e4a7: {
category: "/2/"
name: "Roommodel"
ifcType: null
id: "09e623d4-1e12-4a77-b358-ea1d0b28e4a7"
}
-687c6451-3fa1-47e0-9f13-406833bb06f3: {
category: "/13/"
name: "TGA_Wastewatermodel"
ifcType: null
id: "687c6451-3fa1-47e0-9f13-406833bb06f3"
}
}
...

 

Attachment Service


Attachments are mostly documents or any media files with additional information which can be assigned to any project, object or issue. Please see the detailed structure of the attachment in the Object Model

Get Attachment information
 GET
 Resource: attachments/<attachment_id> 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/attachments/<attachment_id>

Examplehttps://api-stage.bimplus.net/v2/bimplus/attachments/d0b3fc78-8f60-4e3f-ae72-65beb3dcb7d2

 Get detailed information about a specified attachment.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK
    {
        "objectIds": [
            "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
        ],
        "fileName": "Building_Plan.jpg",
        "type": "image/jpeg",
        "size": 211258,
        "createdAt": "2013-12-11T10:47:39",
        "creator": {
        "id": "e18941f4-a809-2d01-d27d-cd251f2b6cb6",
        "email": "test@bimplus.net",
        "firstname": "First Name",
        "lastname": "Second Name",
        "company": "Best-Company",
        "fullname": "First Name Second Name",
        "displayname": "Best-Company",
        "info": "",
        "gender": "",
        "phoneWork": "",
        "phoneHome": "",
        "fax": "",
        "mobile": "",
        "birthDate": "0000-00-00",
        "address": {
            "street": "Westermeier str.",
            "streetNr": "10",
            "zip": "81829",
            "city": "München",
            "country": "Germany"
        },
        "preferedLanguage": "en"
       },
        "id": "6cea110a-88f4-43ac-9a00-ebaf677be333"
    }

Download the attachment
 GET
 Resource: attachments/<attachment_id>/download 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/attachments/<attachment_id>/download

Examplehttps://api-stage.bimplus.net/v2/bimplus/attachments/d0b3fc78-8f60-4e3f-ae72-65beb3dcb7d2/download

 Download the content of a specified attachment.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK

Update the attachment
 GET
 Resource: attachments/<attachment_id> 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/attachments/<attachment_id>

Example:

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

integer

Size of the file to be attached to the project

createdAtwill be ignoredstringCreation date of the attachment
creatorwill be ignoredobjectThe user who created the attachment
 Update or replace a specified existing attachment with a new one.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK

Delete the Attachment
 GET
 Resource: attachments/<attachment_id> 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/attachments/<attachment_id>

Examplehttps://api-stage.bimplus.net/v2/bimplus/attachments/d0b3fc78-8f60-4e3f-ae72-65beb3dcb7d2

 Deletes a specified attachment.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK

 

Issue Service


Issues are problems or remarks which can be assigned to any project. Comments or attachments can be added to the issue. Please see the detailed structure of the issue in the Object Model

Get details of the issue
 GET
 Resource: issues/<issue_id> 

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

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

 Get details of an issue present in a project.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK
{
    "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 all the issue types (Not implemented)
 GET
 Resource: issues/types 

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

Examplehttps://api-stage.bimplus.net/v2/bimplus/issues/types

 Get all the available issue types.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK

Get details of the issue type (Not implemented)
 GET
 Resource: issues/types/<type_id> 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/issues/types/<type_id>

 Get details of a specified issue type.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK

Create a new pin for the issue
 POST
 Resource: issues/<issue_id>/pins 

URLhttps://api-stage.bimplus.net/v2//issues//pins

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

JSON Structure

Name

Mandatory / Optional

Type

Description

issueId

will be ignored

string (guid)

The id of the issue to which the pin is related

objectId

mandatory

string (guid)

The id of the object to which the pin is related

topologyNodeId

will be ignored

string (guid)

The id of the topology to which the pin is attached

position

optional

object

The position of the issue in the building (x,y,z co-ordinates)

normalVector

optional

object

The direction of the issue in the 3D space (x,y,z co-ordinates)

createdAt

will be ignored

date

Creation date of the pin

 Create a new pin for an issue for relating the issue with its object.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
{
    "objectId": "7cf910cb-e357-43f6-aa3a-b45c26380f75",
    "position": {
        "x": "123.45",
        "y": "234.56",
        "z": "345.67"
    },
    "normalVector": {
        "x": "0",
        "y": "1",
        "z": "2"
    }
}
Status: 201 Created
{
    "issueId": "8ead8bfe-ab23-4340-ac47-38181e83bff3",
    "objectId": "7cf910cb-e357-43f6-aa3a-b45c26380f75",
    "topologyNodeId": "387fa6cc-b6f9-4470-8c42-c07982aba660",
    "position": {
        "x": "123.45",
        "y": "234.56",
        "z": "345.67"
    },
    "normalVector": {
        "x": "0",
        "y": "1",
        "z": "2"
    },
    "createdAt": "2013-06-07T10:07:00+00:00",
    "id": "8836308d-f09f-4bb7-b6d2-354a2db205a6"
}

Get all the pins of the issue
 GET
 Resource: issues/<issue_id>/pins 

URLhttps://api-stage.bimplus.net/v2//issues//pins

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

 Get all the pins of a specified issue type.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK
[
    {
        "issueId": "8ead8bfe-ab23-4340-ac47-38181e83bff3",
        "objectId": "00000000-0000-0000-0000-000000000000",
        "topologyNodeId": "387fa6cc-b6f9-4470-8c42-c07982aba660",
        "position": {
            "x": 123.45,
            "y": 234.56,
            "z": 345.67
        },
        "normalVector": {
            "x": 0,
            "y": 1,
            "z": 2
        },
        "createdAt": "2013-06-07T10:07:00",
        "id": "8836308d-f09f-4bb7-b6d2-354a2db205a6"
    }
]

Delete all the pins from the issue
 DELETE
 Resource: issues/<issue_id>/pins 

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

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

 Delete all the pins from a specified issue.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK

Create a new comment for the issue
 POST
 

Resource: issues/<issue_id>/comments 

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

Examplehttps://api-stage.bimplus.net/v2//issues/cb96a9b1-48c9-4d97-8c9e-262476c1c6b2/comments

JSON Structure:

Name

Mandatory / Optional

Type

Description

issueIdwill be ignoredstring(guid)The id of the issue

text

mandatory

string

The comment text

createdAt

will be ignored

string (date)

Creation date of the comment

modifiedAtwill be ignoredstring (date)Modified date of the comment

author

will be ignored

object

The author of the comment

Create a new comment for a specified issue.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
{
    "text": "The fire exit should be x:120, y: 120; z: 340"
}
Status: 201 Created
{
    "issueId": "cb96a9b1-48c9-4d97-8c9e-262476c1c6b2",
    "text": "The fire exit should be x:120, y: 120; z: 340",
    "createdAt": "2013-07-02T13:26:18.8932853+00:00",
    "author": {
        "id": "00000000-0000-0000-0000-000000000000",
        "email": "",
        "firstname": "Unknown",
        "lastname": "User",
        "company": "",
        "fullname": "Unknown User",
        "displayname": "Unknown User",
        "info": "",
        "gender": "",
        "phoneWork": "",
        "phoneHome": "",
        "fax": "",
        "mobile": "",
        "birthDate": "0000-00-00",
        "address": {
            "street": "",
            "streetNr": "",
            "zip": "",
            "city": "",
            "country": ""
        },
        "preferedLanguage": null
    },
    "id": "d258c905-c8af-4463-b0d8-ac09dbcfc255"
}

Get all the comments of the issue
 Get all the comments of a specified issue.
 GET
 Resource: issues/<issue_id>/comments 

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

Examplehttps://api-stage.bimplus.net/v2//issues/cb96a9b1-48c9-4d97-8c9e-262476c1c6b2/comments

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK
[
    {
        "issueId": "cb96a9b1-48c9-4d97-8c9e-262476c1c6b2",
        "text": "The fire exit should be x:120, y: 120; z: 340",
        "createdAt": "2013-07-02T13:26:18+00:00",
        "modifiedAt": "2013-07-03T13:26:18+00:00",
        "author": {
        "id": "00000000-0000-0000-0000-000000000000",
        "email": "",
        "firstname": "Unknown",
        "lastname": "User",
        "company": "",
        "fullname": "Unknown User",
        "displayname": "Unknown User",
        "info": "",
        "gender": "",
        "phoneWork": "",
        "phoneHome": "",
        "fax": "",
        "mobile": "",
        "birthDate": "0000-00-00",
        "address": {
            "street": "",
            "streetNr": "",
            "zip": "",
            "city": "",
            "country": ""
        },
        "preferedLanguage": null
    },
        "id": "d258c905-c8af-4463-b0d8-ac09dbcfc255"
    }
]

Delete all the comments from the issue
 DELETE
 Resource: issues/<issue_id>/comments

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

Examplehttps://api-stage.bimplus.net/v2//issues/cb96a9b1-48c9-4d97-8c9e-262476c1c6b2/comments

 Delete all the comments from the issue.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK

Create a new attachment for the issue
 POST
 Resource: issues/<issue_id>/attachments 

URLhttps://api-stage.bimplus.net/v2//issues//attachments

Example:https://api-stage.bimplus.net/v2/bimplus/issues/8ead8bfe-ab23-4340-ac47-38181e83bff3/attachments

JSON Structure: Please note that all the information required for this call will be taken from the document that you attach and hence the request of this call has no body.

Name

Mandatory / Optional

Type

Description

objectIds

will be ignored

string

The id of the project objects to which the file has to be attached

fileName

will be ignored

string

Name of the file to be attached to the project

type

will be ignored

string

Mime type

size

will be ignored

integer

Size of the file to be attached to the project

createdAtwill be ignoredstringCreation date of the attachment
creatorwill be ignoredobjectThe user who created the attachment
 Creates a new attachment for a specified issue.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: multipart/form-data
Status: 201 Created
    {
        "objectIds": [
            "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
        ],
        "fileName": "Building_Plan.jpg",
        "type": "image/jpeg",
        "size": 211258,
        "createdAt": "2013-12-11T10:47:39",
        "creator": {
        "id": "e18941f4-a809-2d01-d27d-cd251f2b6cb6",
        "email": "test@bimplus.net",
        "firstname": "First Name",
        "lastname": "Second Name",
        "company": "Best-Company",
        "fullname": "First Name Second Name",
        "displayname": "Best-Company",
        "info": "",
        "gender": "",
        "phoneWork": "",
        "phoneHome": "",
        "fax": "",
        "mobile": "",
        "birthDate": "0000-00-00",
        "address": {
            "street": "Westermeier str.",
            "streetNr": "10",
            "zip": "81829",
            "city": "München",
            "country": "Germany"
        },
        "preferedLanguage": "en"
       },
        "id": "6cea110a-88f4-43ac-9a00-ebaf677be333"
    }

Get the attachment list from the issue
 GET
 Resource: issues/<issue_id>/attachments 

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

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

 Gets the attachment list from a specified issue.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK
    {
        "objectIds": [
            "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
        ],
        "fileName": "Building_Plan.jpg",
        "type": "image/jpeg",
        "size": 211258,
        "createdAt": "2013-12-11T10:47:39",
        "creator": {
        "id": "e18941f4-a809-2d01-d27d-cd251f2b6cb6",
        "email": "test@bimplus.net",
        "firstname": "First Name",
        "lastname": "Second Name",
        "company": "Best-Company",
        "fullname": "First Name Second Name",
        "displayname": "Best-Company",
        "info": "",
        "gender": "",
        "phoneWork": "",
        "phoneHome": "",
        "fax": "",
        "mobile": "",
        "birthDate": "0000-00-00",
        "address": {
            "street": "Westermeier str.",
            "streetNr": "10",
            "zip": "81829",
            "city": "München",
            "country": "Germany"
        },
        "preferedLanguage": "en"
       },
        "id": "6cea110a-88f4-43ac-9a00-ebaf677be333"
    }

Delete all the attachments from the issue
 DELETE
 Resource: issues/<issue_id>/attachments 

URLhttps://api-stage.bimplus.net/v2//issues//attachments

Example:https://api-stage.bimplus.net/v2/bimplus/issues/8ead8bfe-ab23-4340-ac47-38181e83bff3/attachments

Delete all the attachments from a specified issue.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK

Update the issue
 PUT
 Resource: issues/<issue_id> 

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

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

JSON Structure

Name

Mandatory / Optional

Type

Description

shortIdwill be ignorednumberReadable unique issue number

projectId

will be ignored

string (guid)

Id of the project

name

optional

string

Name of the issue

description

optional

string

Description of the issue

author

optional

object

Author of the issue

responsibleoptionalobjectResponsible person for the issue

status

optional

string

Status of the issue. Should have one of the values: Open, Solved or Closed

createdAt

will be ignored

string (date)

Creation date of the issue

dueDate

optional

string (date)

The date in which the issue is planned to be finished

solution

optional

string

The proposed solution for the issue

classification

optional

string

The classification to which the issues belongs

priority

optional

string

The priority of the issue. Should have one of the values: Low, Medium or High

 Update or replace a specified existing issue with a new one.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
{
    "name": "Fire Exit Wrong",
    "description": "The fire exit is in the wrong place(x:120, y: 120; z: 340)",
    "author": "Mr. Smart",
    "status": "open"
}
Status: 200 OK

Delete the issue
 DELETE
 Resource: issues/<issue_id> 

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

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

 Deletes a specified issue.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK

 

Pin Service


Pins are relation between an issue and an object. It defines position of an issue in the 3D space. Please see the detailed structure of the pin in the Object Model

Get details of the pin
 GET
 Resource: pins/<pin_id> 

URLhttps://api-stage.bimplus.net/v2//pins/

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

 Get details of a specified pin.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK
{
    "issueId": "8ead8bfe-ab23-4340-ac47-38181e83bff3",
    "objectId": "7cf910cb-e357-43f6-aa3a-b45c26380f75",
    "topologyNodeId": "387fa6cc-b6f9-4470-8c42-c07982aba660",
    "position": {
        "x": 123.45,
        "y": 234.56,
        "z": 345.67
    },
    "normalVector": {
        "x": 0,
        "y": 1,
        "z": 2
    },
    "createdAt": "2013-06-07T10:07:00",
    "id": "8836308d-f09f-4bb7-b6d2-354a2db205a6"
}

Update the pin
 PUT
 Resource: pins/<pin_id> 

URLhttps://api-stage.bimplus.net/v2//pins/

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

JSON Structure

Name

Mandatory / Optional

Type

Description

issueId

mandatory

string (guid)

The id of the issue to which the pin is related

objectId

mandatory

string (guid)

The id of the object to which the pin is related

newObjectId

optional

string (guid)

It should be specified when the pin is assigned to another object via update

topologyNodeId

optional

string (guid)

The id of the topology to which the pin is attached

position

optional

object

The position of the issue in the building (x,y,z co-ordinates)

normalVector

optional

object

The direction of the issue in the 3D space (x,y,z co-ordinates)

createdAt

will be ignored

date

Creation date of the pin

Update or replace a specified existing pin with a new one.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
{
    "issueId": "8ead8bfe-ab23-4340-ac47-38181e83bff3",
    "objectId": "7cf910cb-e357-43f6-aa3a-b45c26380f75",
    "position": {
        "x": 123.45,
        "y": 234.56,
        "z": 345.67
    },
    "normalVector": {
        "x": 0,
        "y": 1,
        "z": 2
    }
}
Status: 200 OK

Delete the pin
 DELETE
 Resource: pins/<pin_id> 

URLhttps://api-stage.bimplus.net/v2//pins/

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

 Deletes a specified pin.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK

 

Comment Service


A particular comment belonging to an issue can be modified using the comment service.

Get details of the comment
 GET
 Resource: comments/<comment_id> 

URLhttps://api-stage.bimplus.net/v2/comments/<comment_id>

Example:https://api-stage.bimplus.net/v2/bimplus/comments/db540336-47a3-426e-b3bf-1e532bfac8ea

 

 Get details of a specified comment.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK
{
    "issueId": "8415bd8d-7e27-4975-bddb-b1b365719770",
    "text": "Second Comment: The fire exit should be x:120, y: 120; z: 340",
    "createdAt": "2013-11-20T08:17:36+00:00",
    "modifiedAt": "2013-11-20T08:17:36+00:00",
    "author": {
        "id": "132a78a5-b523-4bf2-8382-7098fac3f803",
        "email": "test@bimplus.net",
        "status": "Active",
        "firstname": null,
        "lastname": null,
        "company": null,
        "displayname": null,
        "info": null,
        "gender": null,
        "phoneWork": null,
        "phoneHome": null,
        "fax": null,
        "mobile": null,
        "birthDate": null,
        "address": {
            "street": "",
            "streetNr": "",
            "zip": "",
            "city": "",
            "country": ""
        },
        "preferedLanguage": null
    },
    "id": "db540336-47a3-426e-b3bf-1e532bfac8ea"
}

Update the comment
 PUT
 Resource: comments/<comment_id> 

URLhttps://api-stage.bimplus.net/v2/comment/<comment_id>

Examplehttps://api-stage.bimplus.net/v2/bimplus/comments/db540336-47a3-426e-b3bf-1e532bfac8ea

JSON Structure:

Name

Mandatory / Optional

Type

Description

issueIdwill be ignoredstring(guid)The id of the issue

text

mandatory

string

The comment text

createdAt

will be ignored

string (date)

Creation date of the comment

modifiedAtwill be ignoredstring (date)Modified date of the comment

author

optional

object

The author of the comment

Update the specified comment.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
{
    "issueId": "8415bd8d-7e27-4975-bddb-b1b365719770",
    "text": "Second Comment: The fire exit should be x:120, y: 120; z: 340",
    "createdAt": "2013-11-20T08:17:36+00:00",
    "modifiedAt": "2013-11-20T08:17:36+00:00",
    "author": {
        "id": "132a78a5-b523-4bf2-8382-7098fac3f803"
    }
}
Status: 200 OK

Delete the comment
 DELETE
 Resource: comments/<comment_id> 

URLhttps://api-stage.bimplus.net/v2/comments/<comment_id>

Examplehttps://api-stage.bimplus.net/v2/bimplus/comments/8836308d-f09f-4bb7-b6d2-354a2db205a6

 Deletes a specified comment.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK

 

Import Service


This service is used for replacing existing models inside a project by importing the models in the form of IFC and SketchUp files. So, for using this service the model should exist first (which could be either created through the Model Service or the Bimplus portal)

Replace a model by importing SketchUp and IFC files
 POST
 Resource: import 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/model/<model_id>/import

Examplehttps://api-stage.bimplus.net/v2/bimplus/projects/best-project/model/12345/import


 Replace a model in a project by importing SketchUp and IFC files.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 201 Created

 

Slideshow Service


A Slideshow is a group of slides(camera snapshots) attached to a project.

Create a new slideshow
 POST
 Resource: slideshows 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/slideshows

Examplehttps://api-stage.bimplus.net/v2/bimplus/projects/5cd37c77-d341-4ab2-9f0d-44467955/slideshows

JSON Structure

Name

Mandatory / Optional

Type

Description

name

mandatory

string

Name of the slideshow

descriptionoptionalstringDescription of the slideshow
projectIdwill be ignoredstringThe id of the project to which the slideshow belongs
authorwill be ignoredobject (user)Information about the user who has created the slideshow
createdwill be ignoredstring (date)Creation date of the slideshow
idwill be ignoredstring (id)Id of the slideshow
 Creates a new slideshow for a project.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
{
 "name": "My first slideshow"
}
Status: 201 Created
{
    "projectId": "5cd37c77-d341-4ab2-9f0d-44467955b218",
    "name": "My first slideshow",
    "description": null,
    "author": {
        "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
        "email": "jayaraj.purushothaman@gmail.com",
        "firstname": "Jayaraj",
        "lastname": "Purushothaman",
        "company": "Jay Company",
        "fullname": "Jayaraj Purushothaman",
        "displayname": "Jayaraj Purushothaman [Jay Company]",
        "info": "",
        "gender": "MR",
        "phoneWork": "",
        "phoneHome": "",
        "fax": "",
        "mobile": "",
        "birthDate": "0000-00-00",
        "address": {
            "street": "Konrad Zuse platz",
            "streetNr": "1",
            "zip": "81829",
            "city": "Munich",
            "country": "Germany"
        },
        "preferedLanguage": "en"
    },
    "created": "2014-03-06T09:43:00.0929712Z",
    "id": "30f4495a-79d7-48e4-8060-8a52350cfcd9"
}

Get the slideshow list from a project  
 GET
 

Resource: slideshows

URLhttps://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/slideshows

Examplehttps://api-stage.bimplus.net/v2/bimplus/projects/5cd37c77-d341-4ab2-9f0d-44467955/slideshows

 Get the slideshow list belonging to a project.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK
[
    {
        "projectId": "5cd37c77-d341-4ab2-9f0d-44467955b218",
        "name": "My first slideshow",
        "description": null,
        "author": {
            "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "jayaraj.purushothaman@gmail.com",
            "firstname": "Jayaraj",
            "lastname": "Purushothaman",
            "company": "Jay Company",
            "fullname": "Jayaraj Purushothaman",
            "displayname": "Jayaraj Purushothaman [Jay Company]",
            "info": "",
            "gender": "MR",
            "phoneWork": "",
            "phoneHome": "",
            "fax": "",
            "mobile": "",
            "birthDate": "0000-00-00",
            "address": {
                "street": "Konrad Zuse platz",
                "streetNr": "1",
                "zip": "81829",
                "city": "Munich",
                "country": "Germany"
            },
            "preferedLanguage": "en"
        },
        "created": "2014-03-06T09:43:00",
        "id": "30f4495a-79d7-48e4-8060-8a52350cfcd9"
    }
]
Delete all the slideshows from a project
 DELETE
 Resource: slideshows

URLhttps://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/slideshows

Examplehttps://api-stage.bimplus.net/v2/bimplus/projects/5cd37c77-d341-4ab2-9f0d-44467955/slideshows

 Delete all the slideshows from a project
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK

Get details of the slideshow
 GET
 Resourceslideshows/<slideshow_id>

URLhttps://api-stage.bimplus.net/v2/<team_slug>/slideshows/<slideshow_id>

Examplehttps://api-stage.bimplus.net/v2/bimplus/slideshows/586b02be-43b8-4e27-b698-e067e85e38e2

 Get the details of a particular slideshow using its id.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK
{
    "projectId": "5cd37c77-d341-4ab2-9f0d-44467955b218",
    "name": "My first slideshow",
    "description": null,
    "author": {
        "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
        "email": "jayaraj.purushothaman@gmail.com",
        "firstname": "Jayaraj",
        "lastname": "Purushothaman",
        "company": "Jay Company",
        "fullname": "Jayaraj Purushothaman",
        "displayname": "Jayaraj Purushothaman [Jay Company]",
        "info": "",
        "gender": "MR",
        "phoneWork": "",
        "phoneHome": "",
        "fax": "",
        "mobile": "",
        "birthDate": "0000-00-00",
        "address": {
            "street": "Konrad Zuse platz",
            "streetNr": "1",
            "zip": "81829",
            "city": "Munich",
            "country": "Germany"
        },
        "preferedLanguage": "en"
    },
    "created": "2014-03-03T15:31:14",
    "id": "ff375edf-5e8c-4b68-a4a1-fec6b943e7d8"
}

Update the slideshow
 PUT
 Resource: slideshows/<slideshow_id>

URLhttps://api-stage.bimplus.net/v2/<team_slug>/slideshows/<slideshow_id> 

Examplehttps://api-stage.bimplus.net/v2/bimplus/slideshows/586b02be-43b8-4e27-b698-e067e85e38e2

JSON Structure

Name

Mandatory / Optional

Type

Description

name

optional

string

Name of the slideshow

descriptionoptionalstringDescription of the slideshow
projectIdoptionalstringThe id of the project to which the slideshow belongs
authorwill be ignoredobject (user)Information about the user who has created the slideshow
createdwill be ignoredstring (date)Creation date of the slideshow
idwill be ignoredstring (id)Id of the slideshow
 Update a specific slideshow using its id.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
{
    "projectId": "5cd37c77-d341-4ab2-9f0d-44467955b218",
    "name": "Updating my first slideshow",
    "description": null,
    "author": {
        "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed"
    }
}
Status: 200 OK
{
    "projectId": "5cd37c77-d341-4ab2-9f0d-44467955b218",
    "name": "Updating my first slideshow",
    "description": null,
    "author": {
        "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
        "email": null,
        "firstname": null,
        "lastname": null,
        "company": null,
        "fullname": "",
        "displayname": null,
        "info": null,
        "gender": null,
        "phoneWork": null,
        "phoneHome": null,
        "fax": null,
        "mobile": null,
        "birthDate": null,
        "address": {
            "street": "",
            "streetNr": "",
            "zip": "",
            "city": "",
            "country": ""
        },
        "preferedLanguage": null
    },
    "created": "0001-01-01T00:00:00",
    "id": "ff375edf-5e8c-4b68-a4a1-fec6b943e7d8"
}
Delete the slideshow
 DELETE
 Resource: slideshows/<slideshow_id>

URLhttps://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/slideshows/<slideshow_id>

Examplehttps://api-stage.bimplus.net/v2/bimplus/projects/5cd37c77-d341-4ab2-9f0d-44467955/slideshows/ff375edf-5e8c-4b68-a4a1-fec6b943e7d8

 Delete a particular slideshow using its id.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK

Create a new slide for a slideshow
 POST
 Resource: slideshows/<slideshow_id>/slides 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/slideshows/<slideshow_id>/slides

Examplehttps://api-stage.bimplus.net/v2/bimplus/slideshows/30f4495a-79d7-48e4-8060-8a52350cfcd9/slides

JSON Structure

Name

Mandatory / Optional

Type

Description

name

optional

string

Name of the slide

descriptionoptionalstringDescription of the slide
slideInfooptionalstring 
sceneoptionalobject

A JSON string which includes viewMode(transparent or not), camera values & positions, related objects, clipping plane, topology & layer details. An example template is specified below.

Please remember, the server will process the scene information as a json string and hence the client has to take care on the information that is stored & retrieved.

authorwill be ignoredobject (user)Information about the user who has created the slide
createdwill be ignoredstring (date)Creation date of the slide
idwill be ignoredstring (id)Id of the slide


An example scene template:

"scene": { "viewMode": "transparent", "camera": { "fov": 45, "position": { "x": 1231.4, "y": 234.3, "z": 3123.7 }, "quaternion": { "x": 0.9, "y": 0.7, "z": 0.7, "w": 0.23 }, "target": { "objectId": "<GUID>", "position": { "x": 1231.4, "y": 234.3, "z": 3123.7 } } }, "objects": { "selected": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 ], "transparent": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 ], "hidden": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 ] }, "clippingPlane": { "axis": "x", "distance": -123.5, "selected": false }, "topology": [ [ "<nodeId>", "<disciplineId>" ], [ "<nodeId2>", "<disciplineId2>" ] ], "layers": [ { "id": "<GUID>", "divisionTopologyId": "<GUID>", "visible": true, "transparent": false } ] }

 Creates a new slide for a specific slideshow.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
{
    "name": "My first slide",
    "scene": {
        "viewMode": "transparent",
        "camera": {
            "fov": 45,
            "position": {
                "x": 1231.4,
                "y": 234.3,
                "z": 3123.7
            },
            "quaternion": {
                "x": 0.9,
                "y": 0.7,
                "z": 0.7,
                "w": 0.23
            },
            "target": {
                "objectId": "<GUID>",
                "position": {
                    "x": 1231.4,
                    "y": 234.3,
                    "z": 3123.7
                }
            }
        },
        "objects": {
            "selected": [
                0,
                1,
                2,
                3,
                4,
                5,
                6,
                7,
                8,
                9
            ],
            "transparent": [
                0,
                1,
                2,
                3,
                4,
                5,
                6,
                7,
                8,
                9
            ],
            "hidden": [
                0,
                1,
                2,
                3,
                4,
                5,
                6,
                7,
                8,
                9
            ]
        },
        "clippingPlane": {
            "axis": "x",
            "distance": -123.5,
            "selected": false
        },
        "topology": [
            [
                "<nodeId>",
                "<disciplineId>"
            ],
            [
                "<nodeId2>",
                "<disciplineId2>"
            ]
        ],
        "layers": [
            {
                "id": "<GUID>",
                "divisionTopologyId": "<GUID>",
                "visible": true,
                "transparent": false
            }
        ]
    }
}
Status: 201 Created
{
    "name": "My first slide",
    "description": null,
    "slideInfo": "",
    "scene": {
        "viewMode": "transparent",
        "camera": {
            "fov": 45,
            "position": {
                "x": 1231.4,
                "y": 234.3,
                "z": 3123.7
            },
            "quaternion": {
                "x": 0.9,
                "y": 0.7,
                "z": 0.7,
                "w": 0.23
            },
            "target": {
                "objectId": "<GUID>",
                "position": {
                    "x": 1231.4,
                    "y": 234.3,
                    "z": 3123.7
                }
            }
        },
        "objects": {
            "selected": [
                0,
                1,
                2,
                3,
                4,
                5,
                6,
                7,
                8,
                9
            ],
            "transparent": [
                0,
                1,
                2,
                3,
                4,
                5,
                6,
                7,
                8,
                9
            ],
            "hidden": [
                0,
                1,
                2,
                3,
                4,
                5,
                6,
                7,
                8,
                9
            ]
        },
        "clippingPlane": {
            "axis": "x",
            "distance": -123.5,
            "selected": false
        },
        "topology": [
            [
                "<nodeId>",
                "<disciplineId>"
            ],
            [
                "<nodeId2>",
                "<disciplineId2>"
            ]
        ],
        "layers": [
            {
                "id": "<GUID>",
                "divisionTopologyId": "<GUID>",
                "visible": true,
                "transparent": false
            }
        ]
    },
    "created": "2014-03-06T09:52:58.4376633Z",
    "author": {
        "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
        "email": "jayaraj.purushothaman@gmail.com",
        "firstname": "Jayaraj",
        "lastname": "Purushothaman",
        "company": "Jay Company",
        "fullname": "Jayaraj Purushothaman",
        "displayname": "Jayaraj Purushothaman [Jay Company]",
        "info": "",
        "gender": "MR",
        "phoneWork": "",
        "phoneHome": "",
        "fax": "",
        "mobile": "",
        "birthDate": "0000-00-00",
        "address": {
            "street": "Konrad Zuse platz",
            "streetNr": "1",
            "zip": "81829",
            "city": "Munich",
            "country": "Germany"
        },
        "preferedLanguage": "en"
    },
    "id": "60c23ad7-c4b6-4387-b273-1dff2b1dc895"
}

Get the slide list from a slideshow  
 GET
 

Resource: slideshows/<slideshow_id>/slides

URLhttps://api-stage.bimplus.net/v2/<team_slug>/slideshows/<slideshow_id>/slides

Examplehttps://api-stage.bimplus.net/v2/bimplus/slideshows/30f4495a-79d7-48e4-8060-8a52350cfcd9/slides

 Get the slide list belonging to a slideshow
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK
[
    {
        "name": "My first slide",
        "description": null,
        "slideInfo": "",
        "scene": {
            "viewMode": "transparent",
            "camera": {
                "fov": 45,
                "position": {
                    "x": 1231.4,
                    "y": 234.3,
                    "z": 3123.7
                },
                "quaternion": {
                    "x": 0.9,
                    "y": 0.7,
                    "z": 0.7,
                    "w": 0.23
                },
                "target": {
                    "objectId": "<GUID>",
                    "position": {
                        "x": 1231.4,
                        "y": 234.3,
                        "z": 3123.7
                    }
                }
            },
            "objects": {
                "selected": [
                    0,
                    1,
                    2,
                    3,
                    4,
                    5,
                    6,
                    7,
                    8,
                    9
                ],
                "transparent": [
                    0,
                    1,
                    2,
                    3,
                    4,
                    5,
                    6,
                    7,
                    8,
                    9
                ],
                "hidden": [
                    0,
                    1,
                    2,
                    3,
                    4,
                    5,
                    6,
                    7,
                    8,
                    9
                ]
            },
            "clippingPlane": {
                "axis": "x",
                "distance": -123.5,
                "selected": false
            },
            "topology": [
                [
                    "<nodeId>",
                    "<disciplineId>"
                ],
                [
                    "<nodeId2>",
                    "<disciplineId2>"
                ]
            ],
            "layers": [
                {
                    "id": "<GUID>",
                    "divisionTopologyId": "<GUID>",
                    "visible": true,
                    "transparent": false
                }
            ]
        },
        "created": "2014-03-06T09:52:58",
        "author": {
            "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "jayaraj.purushothaman@gmail.com",
            "firstname": "Jayaraj",
            "lastname": "Purushothaman",
            "company": "Jay Company",
            "fullname": "Jayaraj Purushothaman",
            "displayname": "Jayaraj Purushothaman [Jay Company]",
            "info": "",
            "gender": "MR",
            "phoneWork": "",
            "phoneHome": "",
            "fax": "",
            "mobile": "",
            "birthDate": "0000-00-00",
            "address": {
                "street": "Konrad Zuse platz",
                "streetNr": "1",
                "zip": "81829",
                "city": "Munich",
                "country": "Germany"
            },
            "preferedLanguage": "en"
        },
        "id": "60c23ad7-c4b6-4387-b273-1dff2b1dc895"
    }
]

Get the details of a slide
 GET
 Resource: slides/<slide_id>

URLhttps://api-stage.bimplus.net/v2/<team_slug>/slides/<slide_id>

Examplehttps://api-stage.bimplus.net/v2/bimplus/slides/60c23ad7-c4b6-4387-b273-1dff2b1dc895

 Get the details of a particular slide using its id.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK
{
    "name": "My first slide",
    "description": null,
    "slideInfo": "",
    "scene": {
        "viewMode": "transparent",
        "camera": {
            "fov": 45,
            "position": {
                "x": 1231.4,
                "y": 234.3,
                "z": 3123.7
            },
            "quaternion": {
                "x": 0.9,
                "y": 0.7,
                "z": 0.7,
                "w": 0.23
            },
            "target": {
                "objectId": "<GUID>",
                "position": {
                    "x": 1231.4,
                    "y": 234.3,
                    "z": 3123.7
                }
            }
        },
        "objects": {
            "selected": [
                0,
                1,
                2,
                3,
                4,
                5,
                6,
                7,
                8,
                9
            ],
            "transparent": [
                0,
                1,
                2,
                3,
                4,
                5,
                6,
                7,
                8,
                9
            ],
            "hidden": [
                0,
                1,
                2,
                3,
                4,
                5,
                6,
                7,
                8,
                9
            ]
        },
        "clippingPlane": {
            "axis": "x",
            "distance": -123.5,
            "selected": false
        },
        "topology": [
            [
                "<nodeId>",
                "<disciplineId>"
            ],
            [
                "<nodeId2>",
                "<disciplineId2>"
            ]
        ],
        "layers": [
            {
                "id": "<GUID>",
                "divisionTopologyId": "<GUID>",
                "visible": true,
                "transparent": false
            }
        ]
    },
    "created": "2014-03-06T09:52:58",
    "author": {
        "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
        "email": "jayaraj.purushothaman@gmail.com",
        "firstname": "Jayaraj",
        "lastname": "Purushothaman",
        "company": "Jay Company",
        "fullname": "Jayaraj Purushothaman",
        "displayname": "Jayaraj Purushothaman [Jay Company]",
        "info": "",
        "gender": "MR",
        "phoneWork": "",
        "phoneHome": "",
        "fax": "",
        "mobile": "",
        "birthDate": "0000-00-00",
        "address": {
            "street": "Konrad Zuse platz",
            "streetNr": "1",
            "zip": "81829",
            "city": "Munich",
            "country": "Germany"
        },
        "preferedLanguage": "en"
    },
    "id": "60c23ad7-c4b6-4387-b273-1dff2b1dc895"
}

Update the details of a slide
 PUT
 Resource: slides/<slide_id>

URLhttps://api-stage.bimplus.net/v2/<team_slug>/slides/<slide_id> 

Examplehttps://api-stage.bimplus.net/v2/bimplus/slideshows/586b02be-43b8-4e27-b698-e067e85e38e2

JSON Structure

Name

Mandatory / Optional

Type

Description

name

optional

string

Name of the slideshow

descriptionoptionalstringDescription of the slideshow
projectIdoptionalstringThe id of the project to which the slideshow belongs
authorwill be ignoredobject (user)Information about the user who has created the slideshow
createdwill be ignoredstring (date)Creation date of the slideshow
idwill be ignoredstring (id)Id of the slideshow
 Update a specific slideshow using its id.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
{
    "projectId": "5cd37c77-d341-4ab2-9f0d-44467955b218",
    "name": "Updating my first slide",
    "description": null,
    "author": {
        "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed"
    }
}
Status: 200 OK
{
    "projectId": "5cd37c77-d341-4ab2-9f0d-44467955b218",
    "name": "Updating my first slideshow",
    "description": null,
    "author": {
        "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
        "email": null,
        "firstname": null,
        "lastname": null,
        "company": null,
        "fullname": "",
        "displayname": null,
        "info": null,
        "gender": null,
        "phoneWork": null,
        "phoneHome": null,
        "fax": null,
        "mobile": null,
        "birthDate": null,
        "address": {
            "street": "",
            "streetNr": "",
            "zip": "",
            "city": "",
            "country": ""
        },
        "preferedLanguage": null
    },
    "created": "0001-01-01T00:00:00",
    "id": "ff375edf-5e8c-4b68-a4a1-fec6b943e7d8"
}
Delete a slide from a slideshow
 DELETE
 Resource: slides/slide

URLhttps://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/slides/<slide_id>

Examplehttps://api-stage.bimplus.net/v2/bimplus/projects/5cd37c77-d341-4ab2-9f0d-44467955/slides/ff375edf-5e8c-4b68-a4a1-fec6b943e7d8

 Delete a particular slide using its id.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK

Create a thumbnail for a slideshow
 POST
 Resource: slides/<slide_id>/thumbnail

URLhttps://api-stage.bimplus.net/v2/<team_slug>/slideshows/<slideshow_id>/thumbnail

Examplehttps://api-stage.bimplus.net/v2/bimplus/slideshows/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e/thumbnail

 Creates or uploads a thumbnail to a slideshow.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: multipart/form-data
Status: 201 Created
{
    "fileName": "Slideshow1.png",
    "type": "image/png",
    "size": 21320,
    "id": "60c23ad7-c4b6-4387-b273-1dff2b1dc895"
}

Download the thumbnail from a slideshow
 GET
 Resource: slide/<slide_id>/thumbnail/download

URLhttps://api-stage.bimplus.net/v2/<team_slug>/thumbnail/<thumbnail_id>

Examplehttps://api-stage.bimplus.net/v2/bimplus/thumbnail/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e

 Downloads the thumbnail of a slideshow.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: multipart/form-data
Status: 200 OK

Create a thumbnail for a slide
 POST
 Resource: slides/<slide_id>/thumbnail

URLhttps://api-stage.bimplus.net/v2/<team_slug>/slides/<slide_id>/thumbnail

Examplehttps://api-stage.bimplus.net/v2/bimplus/slides/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e/thumbnail

 Creates or uploads a thumbnail to a slide.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: multipart/form-data
Status: 201 Created
{
    "fileName": "Slide1.png",
    "type": "image/png",
    "size": 21320,
    "id": "60c23ad7-c4b6-4387-b273-1dff2b1dc895"
}

Download the thumbnail from a slide
 GET
 Resource: slide/<slide_id>/thumbnail/download

URLhttps://api-stage.bimplus.net/v2/<team_slug>/thumbnail/>thumbnail_id>

Examplehttps://api-stage.bimplus.net/v2/bimplus/thumbnail/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e

 Downloads the thumbnail of a slide.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: multipart/form-data
Status: 200 OK

Authorization Service


Authorizes a user and returns a token for further API calls
 POST
 Resource: authorize 

URLhttps://api-stage.bimplus.net/v2/authorize

JSON Structure

Name

Mandatory / Optional

Type

Description

user_id

mandatory

string

The email address of the user

password

mandatory

string

The user's password

client_id

optional

string

The identifier of the used client

application_id

optional

string

The id of the application

 Authorizes a user and returns a token for further API calls.

Please, use the client_id from the request and regenerate the token (using the same API call with client_id as the additional parameter) for having the possibility to login multiple times at the same time. For more information, see here

Content-Type: application/json
{
 "user_id" : "test@bimplus.net",
 "password" : "test"
}
Status: 200 OK
{
"access_token": "9c1874a62c974dcfa75e0132c423a088",
"expires_in": 2591999,
"client_id": "9fd0bb9d-570b-4719-bfae-93e2f879c19a",
"token_type": "BimPlus"
}

Get token information
 GET
 

Resource: authorize

URLhttps://api-stage.bimplus.net/v2/authorize 

 Get information about a specified token(if the specified token exists and not expired).
Content-Type: application/json

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Status: 200 OK
{
    "user_id": "b37b60d4-0f1b-4158-99c4-847254786517",
    "audience": "00000000-0000-0000-0000-000000000000",
    "expires_in": 2271650

} 

where,

Name

Type

Description

user_id

string

The unique user id to be used for any further API calls.

expires_in

string

The remaining lifetime on the access token in seconds

audience

string

In our case the id of the client (Mobile app, Browser …)

Request a cross token
 POST
 Resource: cross-token

URLhttps://api-stage.bimplus.net/v2/cross-token

 This service is basically used for requesting a disposable temporary token which will be used for authenticating against different clients. Based on the given authentication token the user is identified and a one time token is generated and returned.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK
{
cross_token: "b392cee4d0044ef681fa911772668cf9"
expires_in: 299
token_type: "BimPlus"
}

where,

Name

Type

Description

cross_token

string

The temporary token which will be used for cross-authenticate

expires_in

string

The remaining lifetime on the access token in seconds

token_type

string

Type of the token which will be used as part of the header

Cross Authenticate by using cross token
 POST
 

Resource: cross-authorize

URLhttps://api-stage.bimplus.net/v2/cross-authorize

JSON Structure:

Name

Mandatory / Optional

Type

Description

cross_token

mandatory

string

The temporary token which will be used for cross-authenticate

client_id

optional

string

The identifier of the used client

team_id

optional

string

The id of the team

project_id

optional

string

The id of the project

application_id

optional

string

The id of the application

 Based on the one time cross token, the user will be identified and logged in to the given device/client. The one time cross token will be removed but the new token which will be generated as a result of this call be used in the header for the subsequent API calls.

The team_id and project_id information can be provided as part of the call, if the user wants to work on or display(viewer) a particular team or an project.

Content-Type: application/json
{
"cross_token": "b392cee4d0044ef681fa911772668cf9"
}

Status: 200 OK
{
"access_token": "43796fab76d54d2c9cb9120fd7d79c9e",
"expires_in": 2591999,
"client_id": "9fd0bb9d-570b-4719-bfae-93e2f879c19a",
"token_type": "BimPlus"
}

Revoke / Expire the token
 DELETE
 Resource: authorize

URLhttps://api-stage.bimplus.net/v2/authorize 

 The specified token will expire immediately.
Content-Type: application/json

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Status: 200 OK

 

User Management Service


Create a new user
 POST
 Resource: users 

URLhttps://api-stage.bimplus.net/v2/users

Examplehttps://api-stage.bimplus.net/v2/users

JSON Structure:

Name

Mandatory / Optional

Type

Description

email

mandatory

string

Email of the user

status

optional

will be ignored

The status of the account (Active / Inactive)

password

mandatory

string

Password of the user

firstnameoptionalstringFirst name of the user
lastnameoptionalstringLast name of the user
companyoptionalstringCompany of the user
displaynameoptionalstringDisplay name of the user
infooptionalstringInformation of the user
genderoptionalstringGender of the user
phoneWorkoptionalstringOffice phone number of the user
phoneHomeoptionalstringHome phone number of the user
faxoptionalstringFax number of the user
mobileoptionalstringMobile number of the user
birthDateoptionalstringBirth date of the user
addressoptionalobjectAddress of the user
streetoptionalstringStreet name of the user
streetNroptionalstringStreet number of the user
zipoptionalstringZip code
cityoptionalstringCity name of the user
countryoptionalstringCountry name of the user
preferredLanguageoptionalstringPreferred language of the user (will be set in the portal)
teamswill be ignoredarrayTeam list of the user
teamwill be ignoredobjectInformation about an user's team (See the team service)
projectswill be ignoredarrayProject list of the user
projectwill be ignoredobjectInformation about an user's project (See the project service)
 Creates a new user account. Please remember that this service can be used only by the shop/portal (secured using the application_id of portal)
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
{
 "email" : "test@bimplus.net",
 "password" : "test"
}
Status: 201 Created
{
    "projects": [],
    "teams": [],
    "id": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6",
    "email": "test@bimplus.net",
    "status": "Active",
    "firstname": "",
    "lastname": "",
    "company": "",
    "displayname": "",
    "info": "",
    "gender": "",
    "phoneWork": "",
    "phoneHome": "",
    "fax": "",
    "mobile": "",
    "birthDate": "",
    "address": {
        "street": "",
        "streetNr": "",
        "zip": "",
        "city": "",
        "country": ""
    },
    "preferedLanguage": ""
}

Get information about the user
 GET
 Resource: users/<user_id> 

URLhttps://api-stage.bimplus.net/v2/users/<user_id>

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

 Get information about a specified user.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK
{
    "projects": [],
    "teams": [],
    "id": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6",
    "email": "test@bimplus.net",
    "status": "Active",
    "firstname": "",
    "lastname": "",
    "company": "",
    "displayname": "",
    "info": "",
    "gender": "",
    "phoneWork": "",
    "phoneHome": "",
    "fax": "",
    "mobile": "",
    "birthDate": "",
    "address": {
        "street": "",
        "streetNr": "",
        "zip": "",
        "city": "",
        "country": ""
    },
    "preferedLanguage": ""
}

Update information about the user
 PUT
 Resource: users/<user_id> 

URLhttps://api-stage.bimplus.net/v2/users/<user_id>

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

JSON Structure:

Name

Mandatory / Optional

Type

Description

email

mandatory

string

Email of the user

status

mandatory

string

The status of the account (Active / Inactive)

password

mandatory

string

Password of the user

firstnameoptionalstringFirst name of the user
lastnameoptionalstringLast name of the user
companyoptionalstringCompany of the user
displaynameoptionalstringDisplay name of the user
infooptionalstringInformation of the user
genderoptionalstringGender of the user
phoneWorkoptionalstringOffice phone number of the user
phoneHomeoptionalstringHome phone number of the user
faxoptionalstringFax number of the user
mobileoptionalstringMobile number of the user
birthDateoptionalstringBirth date of the user
addressoptionalobjectAddress of the user
streetoptionalstringStreet name of the user
streetNroptionalstringStreet number of the user
zipoptionalstringZip code
cityoptionalstringCity name of the user
countryoptionalstringCountry name of the user
preferredLanguageoptionalstringPreferred language of the user (will be set in the portal)
teamswill be ignoredarrayTeam list of the user
teamwill be ignoredobjectInformation about an user's team (See the team service)
projectswill be ignoredarrayProject list of the user
projectwill be ignoredobjectInformation about an user's project (See the project service)

 

 

 Update information about a specified user. Please remember that this service can be used only by the shop/portal (secured using the application_id of portal)
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
{
    "email": "updated_test@bimplus.net",
    "status": "Active",
    "password": "test"
}
Status: 200 OK
Delete the user
 DELETE
 Resource: users

URLhttps://api-stage.bimplus.net/v2/users/<user_id>

Examplehttps://api-stage.bimplus.net/v2/users/08b8195a-a2ad-11e2-9993-002215ea7d6b

 Delete a specified user. Please remember that this service can be used only by the shop/portal (secured using the application_id of portal)
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK

Get information about the currently logged in user
 GET
 Resource: user 

URLhttps://api-stage.bimplus.net/v2/user

 Get information about the currently logged in user.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK
{
    "projects": [],
    "teams": [],
    "id": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6",
    "email": "test@bimplus.net",
    "status": "Active",
    "firstname": "",
    "lastname": "",
    "company": "",
    "displayname": "",
    "info": "",
    "gender": "",
    "phoneWork": "",
    "phoneHome": "",
    "fax": "",
    "mobile": "",
    "birthDate": "",
    "address": {
        "street": "",
        "streetNr": "",
        "zip": "",
        "city": "",
        "country": ""
    },
    "preferedLanguage": ""
}


Team Management Service


Create a new team and its related database
 POST
 Resource: teams 

URLhttps://api-stage.bimplus.net/v2/teams

JSON Structure

Name

Mandatory / Optional

Type

Description

slug

mandatory

string

The unique name which will be used in the url

name

mandatory

string

Name of the team

displaynamemandatorystringThe name of the team which will be displayed in the client

owner

mandatory

string (guid)

The unique identifier of the user who will be the initial owner

totalStorage

mandatory

integer

The total storage allocated to the the team (the initial storage size as ordered in the shop)

storageStats

will be ignored

integer

The storage statistics of the team (usedSpace, numberOfProjects, numberOfMembers, totalSpace, totalNumberOfProjects, totalNumberOfMembers)

status

will be ignored

string

Active / Inactive

teamWorksConnection

optional

string

Base64 encoded database connection string for legacy applications

dataStorageStatus

optional

string

Online / Offline

haswriteaccesswill be ignoredbooleanWrite access to the team
publicoptionalobjectPublic read/write rights
readoptionalbooleanRead right (viewer right to all the projects under this team to all the registered users)
writeoptionalbooleanWrite right (write right to all the projects under this team to all the registered users)
rightsobjectobjectProject rights
projectCreatewill be ignoredboolean

The client can use this information to check whether a user can create a project for this team

(See the Rights & Roles to learn more about it)

 Create a new team and its related database. Please remember that this service can be used only by the shop/portal (secured using the application_id of portal)
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
{
    "slug": "best-company",
    "name": "Best Company",
    "owner": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6",
    "totalStorage": 500000000,
    "teamWorksConnection": "RGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0O0luaXRpYWwgQ2F0YWxvZz1CaW1QbHVzLlRlbmFudC5BTUFaT05BLU1OVU8wMTcudGhlLWJlc3Q7VXNlciBJRD10aGUtYmVzdDtQYXNzd29yZD00YmZhZWVlZTM5NDBmZjI0ZjhhNjg2MmIxMzk3NzUyYWU1MjlkZDIzO0Nvbm5lY3QgVGltZW91dD0xMA==",
    "dataStorageStatus": "Online",
    "haswriteaccess": false
}
Status: 201 Created
{
    "id": "db038754-2598-4616-9ea2-2c0947f2e93a",
    "slug": "best-company",
    "name": "Best Company",
    "owner": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6",
    "totalStorage": 500000000,
    "storageStats": {
        "usedSpace": 0,
        "numberOfProjects": 0,
        "numberOfMembers": 0,
        "totalSpace": 500000000,
        "totalNumberOfProjects": 0,
        "totalNumberOfMembers": 0
    },
    "status": "Active",
    "teamWorksConnection":     "RGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0O0luaXRpYWwgQ2F0YWxvZz1CaW1QbHVzLlRlbmFudC5BTUFaT05BLU1OVU8wMTcudGhlLWJlc3Q7VXNlciBJRD10aGUtYmVzdDtQYXNzd29yZD00YmZhZWVlZTM5NDBmZjI0ZjhhNjg2MmIxMzk3NzUyYWU1MjlkZDIzO0Nvbm5lY3QgVGltZW91dD0xMA==",
    "dataStorageStatus": "Online",
    "haswriteaccess": false,
    "public": {
        "read": false,
        "write": false
    },
    "rights": {
        "projectCreate": true
    }  
}

Get information about the team
 GET
 Resource: teams/<team_slug> 

URLhttps://api-stage.bimplus.net/v2/teams/<team_slug>

Examplehttps://api-stage.bimplus.net/v2/teams/best-company

 Get information about a specified team.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK
{
    "id": "db038754-2598-4616-9ea2-2c0947f2e93a",
    "slug": "best-company",
    "name": "Best Company",
    "displayname": "Best Company (best-company)",
    "owner": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6",
    "totalStorage": 500000000,
    "storageStats": {
        "usedSpace": 0,
        "numberOfProjects": 0,
        "numberOfMembers": 0,
        "totalSpace": 500000000,
        "totalNumberOfProjects": 0,
        "totalNumberOfMembers": 0
    },
    "status": "Active",
    "teamWorksConnection":   "RGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0O0luaXRpYWwgQ2F0YWxvZz1CaW1QbHVzLlRlbmFudC5BTUFaT05BLU1OVU8wMTcudGhlLWJlc3Q7VXNlciBJRD10aGUtYmVzdDtQYXNzd29yZD00YmZhZWVlZTM5NDBmZjI0ZjhhNjg2MmIxMzk3NzUyYWU1MjlkZDIzO0Nvbm5lY3QgVGltZW91dD0xMA==",
    "dataStorageStatus": "Online",
    "public": {
        "read": false,
        "write": false
    },
    "rights": {
        "projectCreate": true
    }  
}

Update information about the team
 PUT
 Resource: teams/<team_slug> 

URLhttps://api-stage.bimplus.net/v2/teams/<team_slug>

Examplehttps://api-stage.bimplus.net/v2/teams/best-company

JSON Structure

Name

Mandatory / Optional

Type

Description

slug

will be ignored

string

The unique name which will be used in the url

name

mandatory

string

Name of the team

owner

will be ignored

string (guid)

The unique identifier of the user who will be the initial owner

totalStorage

mandatory

integer

The total storage allocated to the the team (the initial storage size as ordered in the shop)

storageStats

will be ignored

integer

The storage statistics of the team (usedSpace, numberOfProjects, numberOfMembers, totalSpace, totalNumberOfProjects, totalNumberOfMembers)

status

mandatory

string

Active / Inactive

teamWorksConnection

will be ignored

string

Base64 encoded database connection string for legacy applications

dataStorageStatus

will be ignored

string

Online / Offline

haswriteaccesswill be ignoredbooleanWrite access to the team
publicoptionalobjectPublic read/write rights
readoptionalbooleanRead right (viewer right to all the projects under this team to all the registered users)
writeoptionalbooleanWrite right (write right to all the projects under this team to all the registered users)
rightsobjectobjectProject rights
projectCreatewill be ignoredboolean

The client can use this information to check whether a user can create a project for this team

(See the Rights & Roles to learn more about it)

Update information about a specified team. Please remember that this service can be used only by the shop/portal (secured using the application_id of portal)
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
{
        "name": "Best Company",
        "totalStorage": 500000000,
        "status": "Active"
}
Status: 200 OK

Delete the team
 DELETE
 Resource: teams/<team_slug> 

URLhttps://api-stage.bimplus.net/v2/teams/<team_id>

Examplehttps://api-stage.bimplus.net/v2/teams/08b8195a-a2ad-11e2-9993-002215ea7d6b

 Delete a specified team. Please remember that this service can be used only by the shop/portal (secured using the application_id of portal)
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK

Get the team list in which the current logged in user is a member of
 GET
 Resource: teams 

URLhttps://api-stage.bimplus.net/v2/teams

 Get a team list in which the current logged in user is a member of
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK
[
    {
        "id": "db038754-2598-4616-9ea2-2c0947f2e93a",
        "slug": "best-company",
        "name": "Best Company",
        "displayname": "Best Company (best-company)",
        "owner": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6",
        "totalStorage": 500000000,
        "storageStats": null,
        "status": "Active",
        "teamWorksConnection": "RGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0O0luaXRpYWwgQ2F0YWxvZz1CaW1QbHVzLlRlbmFudC5BTUFaT05BLU1OVU8wMTcudGhlLWJlc3Q7VXNlciBJRD10aGUtYmVzdDtQYXNzd29yZD00YmZhZWVlZTM5NDBmZjI0ZjhhNjg2MmIxMzk3NzUyYWU1MjlkZDIzO0Nvbm5lY3QgVGltZW91dD0xMA==",
        "dataStorageStatus": "Online",
        "ismyteam": true,
        "rights": {
            "projectCreate": true
        }
    },
    {
        "id": "82884f54-96bf-4e9c-a2fb-44db8379378d",
        "slug": "nemetschek",
        "name": "Nemetschek",
        "displayname": "Nemetschek (nemetschek)",
        "owner": "132a78a5-b523-4bf2-8382-7098fac3f803",
        "totalStorage": 0,
        "storageStats": null,
        "status": "Active",
        "teamWorksConnection": "RGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0OyBJbml0aWFsIENhdGFsb2c9QmltUGx1cy5UZW5hbnQuRGV2OyBVc2VyIElkPWRiYmltbWFudHJvdGVzdDsgUGFzc3dvcmQ9MWprdGNudG9DcU9qeGtIMU9QOXg7IENvbm5lY3QgdGltZW91dD0xMA==",
        "dataStorageStatus": "Online",
        "ismyteam": false,
        "rights": {
            "projectCreate": false
        }
    },
    {
        "id": "7eab1453-a4e7-4d05-983e-031544540e6f",
        "slug": "bimplus-demo",
        "name": "BimPlusDemo",
        "displayname": "BimPlusDemo (bimplus-demo)",
        "owner": "5592c628-588e-f5c0-b08b-088d43de9209",
        "totalStorage": 53687091200,
        "storageStats": null,
        "status": "Active",
        "teamWorksConnection": "RGF0YSBTb3VyY2U9YmltcGx1cy5tYW50cm8ubmV0O0luaXRpYWwgQ2F0YWxvZz1CaW1QbHVzLlRlbmFudC5iaW1wbHVzLWRlbW87VXNlciBJRD1iaW1wbHVzLWRlbW87UGFzc3dvcmQ9YWI3ZDRmNDc5ZGM4YjI1Yjg2MDc0Y2ZmZTNiNDBjZmY2OWQwNzQ1YjtDb25uZWN0IFRpbWVvdXQ9MTA=",
        "dataStorageStatus": "Online",
        "ismyteam": false,
        "rights": {
            "projectCreate": false
        }
    }
]


Membership Management Service


Add the user to the team
 POST
 

Resource: <team_slug>/members 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/members

Examplehttps://api-stage.bimplus.net/v2/best-company/members

JSON Structure

Name

Mandatory / Optional

Type

Description

user

mandatory

object

Information of the user

user.id

mandatory

string

Id of the user

user.email

will be ignored

string

Email of the user

user.status

will be ignored

string

Status of the user(Active / Inactive)

roles

will be ignored

object

Roles of the user

member_status

optional

string

Status of the membership(Active / Passive)

 Add a specified user to a specified team.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
{
    "user": {
        "id": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6"
    },
    "roles": [
        "Member"
    ],
    "member_status": "Active"

}
Status: 200 Ok

Get the member list of the team
 GET
 Resource: <team_slug>/members 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/members

Examplehttps://api-stage.bimplus.net/v2/best-company/members

 Gets the member list of a specified team.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK
[
    {
        "user": {
            "id": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c6",
            "email": "test@bimplus.net",
            "status": "Active"
        },
        "roles": [
            "Member"
        ],
        "status": "Active"
    },
    {
        "user": {
            "id": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c7",
            "email": "customer@bimplus.net",
            "status": "Active"
        },
        "roles": [
            "Member"
        ],
        "status": "Passive"
    }
]

Update information about the user in the team
 PUT
 Resource: <team_slug>/members/<user_id> 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/members/<user_id>

Examplehttps://api-stage.bimplus.net/v2/best-company>/members/b8615afc-99cc-4bcd-b0ca-ff0593ce15c6

JSON Structure

Name

Mandatory / Optional

Type

Description

user

mandatory

object

Information of the user

user.id

mandatory

string

Id of the user

status

mandatory

string

Status of the membership(Active / Passive)

 Update information about a specified user in a team.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
{
        "user": {
            "id": "b8615afc-99cc-4bcd-b0ca-ff0593ce15c7"
        },
        "status": "Active"
    }
Status: 200 OK

Delete the user from the team
 DELETE
 Resource: <team_slug>/members/<user_id> 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/members/<user_id>

Examplehttps://api-stage.bimplus.net/v2/best-company/members/b8615afc-99cc-4bcd-b0ca-ff0593ce15c6

Deletes a specified user from a team. 
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK

 

Rights & Roles Service


Get all the available roles
 GET
 Resource: <team_slug>/roles 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/roles

Examplehttps://api-stage.bimplus.net/v2/best-company/roles

 Get all the available. Right now, we support only project based roles.

Here is the definition of Bimplus Rights & Roles.

 Account
Owner
Project
Admin
Project
Editor
Project
Viewer
Model
Admin
Model
Editor
Model
Viewer
Create Projectxx     
Admin Project (eg. invite)xx     
Edit Projectxxx    
Delete Projectxx     
View Projectxxxxxxx
        
View all Modelsxxxx   
Create Modelxxx    
Admin Model (eg. invite)xx     
Assign User to Modelxxx x  
Edit Modelxxx xx 
Import Dataxxx xx 
Delete Modelxxx x  
View Modelxxxxxxx
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 Ok
[
    {
        "id": "f11d32e2-30b7-4f81-8a74-2165ecc00cf6",
        "name": "Project_Editor",
        "customRole": false,
        "resources": [
            {
                "resource": "UserRightProject",
                "rights": [
                    "Project_Edit",
                    "Project_View",
                    "Model_ViewAll"
                ]
            }
        ]
    },
    {
        "id": "2baca0e4-2eee-4f7c-bc56-22ed54a1859c",
        "name": "Account_Owner",
        "customRole": false,
        "resources": [
            {
                "resource": "UserRightGlobal",
                "rights": [
                    "AllProjects",
                    "AllModels",
                    "Project_Create"
                ]
            }
        ]
    },
    {
        "id": "a298b28d-9711-4a76-9a7d-910cbf144ee5",
        "name": "Project_Admin",
        "customRole": false,
        "resources": [
            {
                "resource": "UserRightProject",
                "rights": [
                    "Project_Admin",
                    "Project_Edit",
                    "Project_Delete",
                    "Project_View",
                    "Model_ViewAll",
                    "Model_Create"
                ]
            }
        ]
    },
    {
        "id": "a618d075-7e4a-4bde-9d58-d2979696fa96",
        "name": "Project_Viewer",
        "customRole": false,
        "resources": [
            {
                "resource": "UserRightProject",
                "rights": [
                    "Project_View",
                    "Model_ViewAll"
                ]
            }
        ]
    }
]

Make a team member part of a project by assigning a role to him
 POST
 

Resource: projects/<project_id>/members 

URLhttps://api-stage.bimplus.net/v2/projects/<project_id>/members 

Examplehttps://api-stage.bimplus.net/v2/projects/b8615afc-99cc-4bcd-b0ca-ff0593ce15c6/members

JSON Structure

Name

Mandatory / Optional

Type

Description

member

mandatory

object

The member who will be assigned a role to the project

id

mandatory

string (guid)

Id of the user

role

mandatory

object

The project role which will be assigned to the team member

id

mandatory

string (guid)

Id of the role

 Assign a project role to an existing member of a team. Only the user with "Account Owner" or "Project Owner" role can use this API call.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
{
  "member": {
    "id": "bf5b2382-1d14-b8df-8454-947f83b45c25"
  },
  role: {
    id: "f11d32e2-30b7-4f81-8a74-2165ecc00cf6"
}
Status: 201 Created
{
  "member": {
    "id": "bf5b2382-1d14-b8df-8454-947f83b45c25",
    "email": "customer@bimplus.net"
  },
  "role": {
    "id": "f11d32e2-30b7-4f81-8a74-2165ecc00cf6",
    "name": "Project_Editor"
}

Get the project members along with their respective roles
 GET

Resource: projects/<project_id>/members 

URLhttps://api-stage.bimplus.net/v2/projects/<project_id>/members 

Examplehttps://api-stage.bimplus.net/v2/projects/b8615afc-99cc-4bcd-b0ca-ff0593ce15c6/members

 Get the member list of a project along with their respective project roles.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK
[
    {
        "member": {
            "id": "7aa846f2-6014-f68d-8dd4-4c7941d7cbcc",
            "email": "customer1@bimplus.net"
        },
        "role": {
            "id": "f11d32e2-30b7-4f81-8a74-2165ecc00cf6",
            "name": "Project_Editor"
        }
    },
    {
        "member": {
            "id": "bf5b2382-1d14-b8df-8454-947f83b45c25",
            "email": "customer2@bimplus.net"
        },
        "role": {
            "id": "e11d32e2-30b7-4f81-8a74-2165ecc00cf6",
            "name": "Project_Viewer"
        }
    }
]

Update the project role of a team member
 PUT
 Resource: projects/<project_id>/members 

URLhttps://api-stage.bimplus.net/v2/projects/<project_id>/members 

Examplehttps://api-stage.bimplus.net/v2/projects/b8615afc-99cc-4bcd-b0ca-ff0593ce15c6/members

JSON Structure

Name

Mandatory / Optional

Type

Description

member

mandatory

object

The member who will be assigned a role to the project

id

mandatory

string (guid)

Id of the user

role

mandatory

object

The project role which will be assigned to the team member

id

mandatory

string (guid)

Id of the role

 Update the project role of a team member. Only the user with "Account Owner" or "Project Owner" role can use this API call.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
{
  "member": {
    "id": "bf5b2382-1d14-b8df-8454-947f83b45c25",
    "email": "customer@bimplus.net"
  },
  "role": {
    "id": "f11d32e2-30b7-4f81-8a74-2165ecc00cf6",
    "name": "Project_Viewer"
}
Status: 200 OK

Remove the user from the project   
 DELETE
 Resource: projects/<project_id>/members 

URLhttps://api-stage.bimplus.net/v2/projects/<project_id>/members 

Examplehttps://api-stage.bimplus.net/v2/projects/b8615afc-99cc-4bcd-b0ca-ff0593ce15c6/members

 Remove the user from a project
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK

User/Team Activation/Deactivation Service


This service can be used to activate/deactivate user/team or to get the list of deactivated users/teams. Please remember that this service can be used only by the shop/portal (secured using the application_id of portal)

Activate or deactivate the user
 PUT
 

Resourceadministration/users/<userId>

URLhttps://api-stage.bimplus.net/v2/administration/users/<userId>

Examplehttps://api-stage.bimplus.net/v2/administration/users/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e

JSON Structure

Name

Mandatory / Optional

Type

Description

activeStatus (active_status can be "active" or "disabled")

mandatory

string ("active" or "disabled")

Whether to activate or deactivate the user

adminId

mandatory

string

The id of the shop admin who has activated/deactivated the user

reason

mandatory

string

Reason for activating/deactivating the user

 Activate or deactivate the specified user. Please remember that this service can be used only by the shop/portal (secured using the application_id of portal)
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
{
    "activeStatus": "Disabled",
    "adminId": "ade041e7312da9e4aghc64403fbcd21517ttt",
    "reason": "Testing the deactivate functionality"
}
Status: 200 OK
{
    "id": "237c8f43-a01b-c6e8-0c14-d167620466ed",
    "email": "test@bimplus.net",
    "status": "Disabled",
    "adminLog": [
        {
            "id": "43d3187e-87a5-4e11-9f68-a2c90097e2ba",
            "action": "Disabled",
            "author": "ade041e7312da9e4aghc64403fbcd21517ttt",
            "reason": "Testing the deactivate functionality",
            "timestamp": "2014-02-05T08:12:59.9252404Z"
        },
        {
            "id": "0f2d654a-3630-4ec9-9039-a2c900977117",
            "action": "Active",
            "author": "ade041e7312da9e4aghc64403fbcd21517ttt",
            "reason": "Testing the deactivate functionality",
            "timestamp": "2014-02-05T08:11:22.9546122"
        },
        {
            "id": "e6081130-7ab5-45a7-a168-a2c8012a560a",
            "action": "Disabled",
            "author": "ade041e7312da9e4aghc64403fbcd21517ttt",
            "reason": "Testing the deactivate functionality",
            "timestamp": "2014-02-04T17:06:12.5076209"
        }
    ]
}

Activate or deactivate the team
 PUT
 

Resourceadministration/users/<teamId>

URLhttps://api-stage.bimplus.net/v2/administration/teams/<teamId>

Examplehttps://api-stage.bimplus.net/v2/administration/teams/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e

JSON Structure

Name

Mandatory / Optional

Type

Description

activeStatus (active_status can be "active" or "disabled")

mandatory

string ("active" or "disabled")

Whether to activate or deactivate the team

adminId

mandatory

string

The id of the shop admin who has activated/deactivated the team

reason

mandatory

string

Reason for activating/deactivating the team

 Activate or deactivate the specified team. Please remember that this service can be used only by the shop/portal (secured using the application_id of portal)
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
{
    "activeStatus": "disabled",
    "adminId": "ase041e7312da9ert4ac64403fbcdde21517h",
    "reason": "Testing the deactivate functionality"
}
Status: 200 OK
{
 "publicRead": false,
 "publicWrite": false,
 "teamDbName": "BimPlus.Tenant.Dev.jay-company",
 "payment": null,
 "lastLogin": "0001-01-01T00:00:00",
 "failedLogins": 0,
 "owner": {
 "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
 "email": "jayaraj.purushothaman@gmail.com",
 "firstname": "Jayaraj",
 "lastname": "Purushothaman",
 "company": "Jay Company",
 "fullname": "Jayaraj Purushothaman",
 "displayname": "Jayaraj Purushothaman [Jay Company]",
 "info": "",
 "gender": "MR",
 "phoneWork": "",
 "phoneHome": "",
 "fax": "",
 "mobile": "",
 "birthDate": "0000-00-00",
 "address": {
 "street": "Konrad Zuse platz",
 "streetNr": "1",
 "zip": "81829",
 "city": "Munich",
 "country": "Germany"
 },
 "preferedLanguage": "de",
 "wrongLogins": 0
 },
 "invitees": 2,
 "teamMembers": [
 {
 "id": "6e67ba07-50c3-d51d-23f0-3ac0d8788202",
 "firstname": "Unknown",
 "lastName": "User",
 "fullName": "Unknown User",
 "email": "jayaraj.purushothaman@bimplus.net",
 "roleName": null,
 "invitationStatus": null
 },
 {
 "id": "237c8f43-a01b-c6e8-0c14-d167620466ed",
 "firstname": "Unknown",
 "lastName": "User",
 "fullName": "Unknown User",
 "email": "ssudha84@gmail.com",
 "roleName": null,
 "invitationStatus": null
 }
 ],
 "adminLog": [
 {
 "id": "efb4a35a-b47b-4b81-bebf-a2cb00a0317f",
 "action": "Disabled",
 "author": "ase041e7312da9ert4ac64403fbcdde21517h",
 "reason": "Testing the deactivate functionality",
 "timestamp": "2014-02-07T08:43:14.7675944Z"
 },
 {
 "id": "ab516ade-a01a-4938-8c28-a2cb00a02170",
 "action": "Active",
 "author": "ase041e7312da9ert4ac64403fbcdde21517h",
 "reason": "Testing the deactivate functionality",
 "timestamp": "2014-02-07T08:43:01.0644085"
 }
 ],
 "id": "c3018713-a313-4bab-a952-2fddb58fb171",
 "slug": "jay-company",
 "name": "Jay Company",
 "server": "k2146.ims-firmen.de",
 "ownerId": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
 "status": "Disabled",
 "countMembers": 3,
 "countProjects": 1,
 "usedSpace": 106
}

Get the list of all the users with the activation status 
 GET
Resource: administration/users

URLhttps://api-stage.bimplus.net/v2/administration/users

Examplehttps://api-stage.bimplus.net/v2/administration/users

 Get the list of all the users with the activation status. Please remember that this service can be used only by the shop/portal (secured using the application_id of portal)

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK
 [
    {
        "id": "6790ad40-99e1-cef2-cabd-1bd05bbb3335",
        "email": "user1@bimplus.net",
        "status": "Active"
    },
    {
        "id": "43d2d1c8-f0eb-9804-d2a2-1f36c8fb7a45",
        "email": "user2@bimplus.net",
        "status": "Disabled"
    },
    {
        "id": "39b31bb4-b413-3dc9-6036-214392facb49",
        "email": "user3@bimplus.net",
        "status": "Active"
    },
    {
        "id": "91188cc9-6202-a9e9-8ada-23fbca9c7b34",
        "email": "user4@bimplus.net",
        "status": "Active"
    }
]

Get the list of all the teams with the activation status 
 GET
Resource: administration/teams

URLhttps://api-stage.bimplus.net/v2/administration/teams

Examplehttps://api-stage.bimplus.net/v2/administration/teams

There is a paging and sorting possibility available for this API call. Please see the request section.

 Get the list of all the teams with the activation status. Please remember that this service can be used only by the shop/portal (secured using the application_id of portal)

There is a paging and sorting possibility available for this API call. Please see the request section.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
 
For the paging & sorting possibility, send the following properties in the header:
pageSize (mandatory for paging): Number of hits which will be displayed on one page
pageIndex (mandatory for paging): The page number which has to be loaded
sortColumn (optional): The name of the column which will be sorted (possible only with some limitations)
sortDirection (optional)("asc" or "desc"): Sort direction (asc is default)
Status: 200 OK
[
    {
        "id": "c9e80035a-de61-4d84-b324-0308cc073a0c",
        "slug": "testteam",
        "name": "testteam",
        "server": "k2145.ims-firmen.de",
        "ownerId": "fc5d0b370-6005-484c-8f47-b9e52e8ac6eaf",
        "status": "Active",
        "countMembers": 1,
        "countProjects": 608,
        "usedSpace": 1973
    },
    {
        "id": "a1e500195-b9cc-495c-bb3a-ab01ada0ca01a",
        "slug": "bimplus-gmbh",
        "name": "Bimplus GmbH",
        "server": "k2145.ims-firmen.de",
        "ownerId": "g6e67ba07-50c3-d51d-23f0-3ac0d8788202g",
        "status": "Active",
        "countMembers": 1,
        "countProjects": 3,
        "usedSpace": 237
    }
]

Get the activation status and the status log for an user 
 GET
Resource: administration/users/<user_id>

URLhttps://api-stage.bimplus.net/v2/administration/users/<user_id>

Examplehttps://api-stage.bimplus.net/v2/administration/users/<user_id>

 Get the activation status and the status log of the specified user. Please remember that this service can be used only by the shop/portal (secured using the application_id of portal)

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK
{
    "id": "237c8f43-a01b-c6e8-0c14-d167620466ed",
    "email": "user1@bimplus.net",
    "status": "Active",
    "adminLog": [
        {
            "id": "3ccecf46-69fa-4a5f-bca3-a2cb0098fcac",
            "action": "Active",
            "author": "ae041e7312da9e4ac64403fbcdde21517b",
            "reason": "Testing the deactivate functionality",
            "timestamp": "2014-02-07T08:17:00.5172929"
        },
        {
            "id": "43d3187e-87a5-4e11-9f68-a2c90097e2ba",
            "action": "Disabled",
            "author": "ce041e7312da9e4ac64403fbcdde21517d",
            "reason": "Testing the deactivate functionality",
            "timestamp": "2014-02-05T08:12:59.9252404"
        },
        {
            "id": "0f2d654a-3630-4ec9-9039-a2c900977117",
            "action": "Active",
            "author": "ae041e7312da9e4ac64403fbcdde21517b",
            "reason": "Testing the deactivate functionality",
            "timestamp": "2014-02-05T08:11:22.9546122"
        },
        {
            "id": "e6081130-7ab5-45a7-a168-a2c8012a560a",
            "action": "Disabled",
            "author": "ae041e7312dagg9e4ac64403fbcdde21517u",
            "reason": "Testing the deactivate functionality",
            "timestamp": "2014-02-04T17:06:12.5076209"
        }
    ]
}

Get the activation status and the status log for a team 
 GET
Resource: administration/teams/<team_id>

URLhttps://api-stage.bimplus.net/v2/administration/teams/<team_id>

Examplehttps://api-stage.bimplus.net/v2/administration/teams/<team_id>

 Get the activation status and the status log of the specified team. Please remember that this service can be used only by the shop/portal (secured using the application_id of portal)

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK
{
    "publicRead": false,
    "publicWrite": false,
    "teamDbName": "BimPlus.Tenant.Dev.jay-company",
    "payment": null,
    "lastLogin": "0001-01-01T00:00:00",
    "failedLogins": 0,
    "owner": {
        "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
        "email": "jayaraj.purushothaman@gmail.com",
        "firstname": "Jayaraj",
        "lastname": "Purushothaman",
        "company": "Jay Company",
        "fullname": "Jayaraj Purushothaman",
        "displayname": "Jayaraj Purushothaman [Jay Company]",
        "info": "",
        "gender": "MR",
        "phoneWork": "",
        "phoneHome": "",
        "fax": "",
        "mobile": "",
        "birthDate": "0000-00-00",
        "address": {
            "street": "Konrad Zuse platz",
            "streetNr": "1",
            "zip": "81829",
            "city": "Munich",
            "country": "Germany"
        },
        "preferedLanguage": "en",
        "wrongLogins": 0
    },
    "invitees": 2,
    "teamMembers": [
        {
            "id": "6e67ba07-50c3-d51d-23f0-3ac0d8788202",
            "firstname": "Unknown",
            "lastName": "User",
            "fullName": "Unknown User",
            "email": "jayaraj.purushothaman@bimplus.net",
            "roleName": null,
            "invitationStatus": null
        },
        {
            "id": "237c8f43-a01b-c6e8-0c14-d167620466ed",
            "firstname": "Unknown",
            "lastName": "User",
            "fullName": "Unknown User",
            "email": "ssudha84@gmail.com",
            "roleName": null,
            "invitationStatus": null
        }
    ],
    "adminLog": [
        {
            "id": "efb4a35a-b47b-4b81-bebf-a2cb00a0317f",
            "action": "Disabled",
            "author": "afe041e7312da9e4ac64403fbcdde215",
            "reason": "Testing the deactivate functionality",
            "timestamp": "2014-02-07T08:43:14.7675944"
        },
        {
            "id": "ab516ade-a01a-4938-8c28-a2cb00a02170",
            "action": "Active",
            "author": "afe041e7312da9e4ac64403fbcdde215",
            "reason": "Testing the deactivate functionality",
            "timestamp": "2014-02-07T08:43:01.0644085"
        }
    ],
    "id": "c3018713-a313-4bab-a952-2fddb58fb171",
    "slug": "jay-company",
    "name": "Jay Company",
    "server": "k2146.ims-firmen.de",
    "ownerId": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
    "status": "Disabled",
    "countMembers": 3,
    "countProjects": 1,
    "usedSpace": 106
}


Database Server Statistics Service


Get all the database server details 
 GET
Resource: administration/dbserverstatistics

URLhttps://api-stage.bimplus.net/v2/administration/dbserverstatistics

Examplehttps://api-stage.bimplus.net/v2/administration/dbserverstatistics

 Retrieves the details of all the DB servers found in the Bimplus platform. Please remember that this service can be used only by the shop/portal (secured using the application_id of portal)

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK
 [
    {
        "id": "6c3bcbd4-df39-4b5c-9d55-257d15b6f2f2",
        "dbServerName": "k3345.ims-firmen.de",
        "dbServerStatus": "Active",
        "usageStatisticsIsWorking": true,
        "dbServerIsClosed": false,
        "dbSpaceTotal": 800000,
        "dbSpaceUsed": 24603,
        "growingSumLastWeekSpaceUsed": 2717,
        "growingSumLastMonthSpaceUsed": 14853,
        "growingPerDayLastWeekSpaceUsed": 388.14285714285717,
        "growingPerDayLastMonthSpaceUsed": 479.1290322580645,
        "growingDaysLastMonth": 31,
        "growingDaysLastWeek": 7,
        "dbSpaceRemaining": 775397,
        "dbSpaceRemainingPercentage": 96.9,
        "numberOfTeams": 100,
        "growingSumLastWeekTeams": 12,
        "growingSumLastMonthTeams": 63,
        "growingPerDayLastWeekTeams": 1.7142857142857142,
        "growingPerDayLastMonthTeams": 2.032258064516129,
        "numberOfProjects": 194,
        "growingSumLastWeekProjects": 30,
        "growingSumLastMonthProjects": 123,
        "growingPerDayLastWeekProjects": 4.285714285714286,
        "growingPerDayLastMonthProjects": 3.967741935483871,
        "numberOfProjectsMin": 0,
        "numberOfProjectsMax": 32,
        "teamDbSpaceMin": 20,
        "teamDbSpaceMax": 3017,
        "popularity": 98.5742,
        "unitSpace": "MB"
    },
    {
        "id": "c37d4829-b547-4c8d-b031-ffd2101b7c54",
        "dbServerName": "k2222.ims-firmen.de",
        "dbServerStatus": "Active",
        "usageStatisticsIsWorking": true,
        "dbServerIsClosed": false,
        "dbSpaceTotal": 800000,
        "dbSpaceUsed": 19011,
        "growingSumLastWeekSpaceUsed": 2114,
        "growingSumLastMonthSpaceUsed": 9595,
        "growingPerDayLastWeekSpaceUsed": 302,
        "growingPerDayLastMonthSpaceUsed": 309.51612903225805,
        "growingDaysLastMonth": 31,
        "growingDaysLastWeek": 7,
        "dbSpaceRemaining": 780989,
        "dbSpaceRemainingPercentage": 97.6,
        "numberOfTeams": 101,
        "growingSumLastWeekTeams": 12,
        "growingSumLastMonthTeams": 68,
        "growingPerDayLastWeekTeams": 1.7142857142857142,
        "growingPerDayLastMonthTeams": 2.193548387096774,
        "numberOfProjects": 147,
        "growingSumLastWeekProjects": 26,
        "growingSumLastMonthProjects": 96,
        "growingPerDayLastWeekProjects": 3.7142857142857144,
        "growingPerDayLastMonthProjects": 3.096774193548387,
        "numberOfProjectsMin": 0,
        "numberOfProjectsMax": 26,
        "teamDbSpaceMin": 20,
        "teamDbSpaceMax": 4447,
        "popularity": 98.16266,
        "unitSpace": "MB"
    }
]

Get the particular database server details 
 GET
Resource: administration/dbserverstatistics/<server_id>

URLhttps://api-stage.bimplus.net/v2/administration/dbserverstatistics/<server_id>

Examplehttps://api-stage.bimplus.net/v2/administration/dbserverstatistics/cccbcbd4-df39-4b5c-9d55-257d15b6f2f2

 Retrieves the details of a particular database server. Please remember that this service can be used only by the shop/portal (secured using the application_id of portal)

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK
{
    "id": "cccbcbd4-df39-4b5c-9d55-257d15b6f2f2",
    "dbServerName": "k2222.ims-firmen.de",
    "dbServerStatus": "Active",
    "usageStatisticsIsWorking": true,
    "dbServerIsClosed": false,
    "dbSpaceTotal": 800000,
    "dbSpaceUsed": 24603,
    "growingSumLastWeekSpaceUsed": 2717,
    "growingSumLastMonthSpaceUsed": 14853,
    "growingPerDayLastWeekSpaceUsed": 388.14285714285717,
    "growingPerDayLastMonthSpaceUsed": 479.1290322580645,
    "growingDaysLastMonth": 31,
    "growingDaysLastWeek": 7,
    "dbSpaceRemaining": 775397,
    "dbSpaceRemainingPercentage": 96.9,
    "numberOfTeams": 100,
    "growingSumLastWeekTeams": 12,
    "growingSumLastMonthTeams": 63,
    "growingPerDayLastWeekTeams": 1.7142857142857142,
    "growingPerDayLastMonthTeams": 2.032258064516129,
    "numberOfProjects": 194,
    "growingSumLastWeekProjects": 30,
    "growingSumLastMonthProjects": 123,
    "growingPerDayLastWeekProjects": 4.285714285714286,
    "growingPerDayLastMonthProjects": 3.967741935483871,
    "numberOfProjectsMin": 0,
    "numberOfProjectsMax": 32,
    "teamDbSpaceMin": 20,
    "teamDbSpaceMax": 3017,
    "popularity": 98.5742,
    "unitSpace": "MB",
    "adminLog": []
}

 

Database Move Service


Move the database from one server to another
 PUT
 Resource: administration/teams/<team_id>/move

URLhttps://api-stage.bimplus.net/v2/administration/teams/<team_id>/move

Examplehttps://api-stage.bimplus.net/v2/administration/teams/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e/move

JSON Structure

Name

Mandatory / Optional

Type

Description

targetServerId

mandatory

string

The id of the target db server

adminId

optional

string

The id of the shop admin who has moved the db

 Move the database from one server to another. Please remember that this service can be used only by the shop/portal (secured using the application_id of portal)
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
{
    "targetServerId": "cfb2e0fb1d-a8f7-45d8e-ad1e-11c341ab4a53zu",
    "adminId": "662835-9f5b-961fer-84b9-4dbdcc0ac1"
}
Status: 200 OK
{
    "publicRead": false,
    "publicWrite": false,
    "teamDbName": "BimPlus.Tenant.Dev.jay-company",
    "payment": null,
    "lastLogin": "0001-01-01T00:00:00",
    "failedLogins": 0,
    "owner": {
        "id": "e0ac3b-fa49-e540-ac2f-8ca3dd72ed",
        "email": "jayaraj.purushothaman@gmail.com",
        "firstname": "Jayaraj",
        "lastname": "Purushothaman",
        "company": "Jay Company",
        "fullname": "Jayaraj Purushothaman",
        "displayname": "Jayaraj Purushothaman [Jay Company]",
        "info": "",
        "gender": "MR",
        "phoneWork": "",
        "phoneHome": "",
        "fax": "",
        "mobile": "",
        "birthDate": "0000-00-00",
        "address": {
            "street": "Konrad Zuse platz",
            "streetNr": "1",
            "zip": "81829",
            "city": "Munich",
            "country": "Germany"
        },
        "preferedLanguage": "en",
        "wrongLogins": 0
    },
    "invitees": 2,
    "teamMembers": [
        {
            "id": "6e67ba07-50c3-d51d-23f0-3ac0d8788202",
            "firstname": "Unknown",
            "lastName": "User",
            "fullName": "Unknown User",
            "email": "jayaraj.purushothaman@bimplus.net",
            "roleName": null,
            "invitationStatus": null
        },
        {
            "id": "237c8f43-a01b-c6e8-0c14-d167620466ed",
            "firstname": "Unknown",
            "lastName": "User",
            "fullName": "Unknown User",
            "email": "ssudha84@gmail.com",
            "roleName": null,
            "invitationStatus": null
        }
    ],
    "adminLog": [
        {
            "id": "996b1cb5-8942-4f60-91e9-a2cb00c975ca",
            "action": "Disabled",
            "author": "662835-9f5b-961fer-84b9-4dbdcc0ac1",
            "reason": "Testing the deactivate functionality",
            "timestamp": "2014-02-07T11:13:29.6298927"
        },
        {
            "id": "e3f5f3d7-e174-4a39-9078-a2cb00b65726",
            "action": "Active",
            "author": "662835-9f5b-961fer-84b9-4dbdcc0ac1",
            "reason": "Testing the deactivate functionality",
            "timestamp": "2014-02-07T10:03:52.8723593"
        },
        {
            "id": "efb4a35a-b47b-4b81-bebf-a2cb00a0317f",
            "action": "Disabled",
            "author": "662835-9f5b-961fer-84b9-4dbdcc0ac1",
            "reason": "Testing the deactivate functionality",
            "timestamp": "2014-02-07T08:43:14.7675944"
        },
        {
            "id": "ab516ade-a01a-4938-8c28-a2cb00a02170",
            "action": "Active",
            "author": "662835-9f5b-961fer-84b9-4dbdcc0ac1",
            "reason": "Testing the deactivate functionality",
            "timestamp": "2014-02-07T08:43:01.0644085"
        }
    ],
    "id": "c3018713-a313-4bab-a952-2fddb58fb171",
    "slug": "jay-company",
    "name": "Jay Company",
    "server": "k1234.ims-firmen.de",
    "ownerId": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
    "status": "Disabled",
    "countMembers": 3,
    "countProjects": 1,
    "usedSpace": 135
}

 

Messaging Service


Create a new message for an user
 POST
 

Resource: messages 

URLhttps://api-stage.bimplus.net/v2/messages

Examplehttps://api-stage.bimplus.net/v2/messages

JSON Structure

Name

Mandatory / Optional

Type

Description

id

will be ignored

string

Id of the message

userId

mandatory

string

Id of the user

source

mandatory

string

Source of the message (eg: Import Service)

topic

mandatory

string

Topic of the message

severity

mandatory

object

Severity can be Info, Warning, Error

returnCode

mandatory

string

Readable return code

timestampwill be ignoredstringCreation date of the message
unreadmandatorybooleanWhether the message was unread
additionalDataoptionalstringExtra info
correlationIdoptionalguidId of the other related message
 Create a new message for an user.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
{
    "id": "4633d522-53aa-4d81-90b4-704681e0573d",
    "userid": "c7040e44-508a-4d10-88dc-b7c7ace6c650",
    "source": "ServiceName",
    "topic": "SKETCHUP_JOB",
    "severity": "Warn",
    "returncode": "FILE_TOO_BIG",
    "unread": false,
    "timestamp": "2013-11-15T10:55:53"
}
Status: 201 Created

Get the message list of the current user
 GET
 Resource: messages 

URLhttps://api-stage.bimplus.net/v2/messages

Examplehttps://api-stage.bimplus.net/v2/messages

 Gets the message list of the current user
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK
[
    {
        "id": "481713d6-7dab-410c-8c8a-d65ff1d4a766",
        "userid": "b7040e44-508a-4d00-88dc-b7c7ace6c650",
        "source": "ServiceName2",
        "topic": "SKETCHUP_JOB",
        "severity": "Info",
        "returncode": "FILE_TOO_BIG",
        "timestamp": "2013-11-18T14:55:22",
        "unread": false,
        "additionaldata": null,
        "correlationid": null
    },
    {
        "id": "93c29c5d-1391-4ae8-8876-ef9815e60f7d",
        "userid": "b7040e44-508a-4d00-88dc-b7c7ace6c650",
        "source": "ServiceName",
        "topic": "IFC_JOB",
        "severity": "Info",
        "returncode": "OK",
        "timestamp": "2013-11-18T14:30:53",
        "unread": true,
        "additionaldata": null,
        "correlationid": null
    }
]

Get information about a specified message
 GET
 Resource: messages 

URLhttps://api-stage.bimplus.net/v2/messages/<message_id>

Examplehttps://api-stage.bimplus.net/v2/messages/<message_id>

 Get information about a specified message
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK
{
    "id": "93c29c5d-1391-4ae8-8876-ef9815e60f7d",
    "userid": "b7040e44-508a-4d00-88dc-b7c7ace6c650",
    "source": "ServiceName",
    "topic": "IFC_JOB",
    "severity": "Info",
    "returncode": "OK",
    "timestamp": "2013-11-18T14:30:53",
    "unread": true,
    "additionaldata": null,
    "correlationid": null
}

Delete the specified message
 DELETE
 Resource: messages/<message_id> 

URLhttps://api-stage.bimplus.net/v2/messages/<message_id>

Examplehttps://api-stage.bimplus.net/v2/messages/<message_id>

 Delete the specified message.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK

Mark a message as "read"
 POST
 Resource: messages/<message_id>/markasread 

URLhttps://api-stage.bimplus.net/v2/messages/<message_id>/markasread 

Examplehttps://api-stage.bimplus.net/v2/messages/<message_id>/markasread

 Mark a message as read.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK

 

Log Service


Get all the log data
 GET
Resource: logs 

URLhttps://api-stage.bimplus.net/v2/logs

Examplehttps://api-stage.bimplus.net/v2/logs

 Retrieves the whole log information from the beginning of the time.

It is always better to use the other log API call which retrieves the log info between the time interval as this API will cause serious bandwidth usage

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK
[
     {
        "id": 853539,
        "server": "K2177",
        "date": "2013-12-16T10:00:23",
        "requestid": "653750b3-a97e-451f-bd01-1a4671344087",
        "thread": "51",
        "level": "INFO",
        "logger": "PerformanceLog.ServiceLog",
        "message": "BEGIN Request (GET /v2/best-company/projects/679532b9-f7f7-41ce-817f-6e58225b32b1/disciplines)",
        "exception": ""
    },
    {
        "id": 853540,
        "server": "K2177",
        "date": "2013-12-16T10:00:23",
        "requestid": "653750b3-a97e-451f-bd01-1a4671344087",
        "thread": "51",
        "level": "INFO",
        "logger": "PerformanceLog.UserLog",
        "message": "User found byId: bestcustomer@bimplus.net",
        "exception": ""
    },
    {
        "id": 853541,
        "server": "K2177",
        "date": "2013-12-16T10:00:23",
        "requestid": "653750b3-a97e-451f-bd01-1a4671344087",
        "thread": "51",
        "level": "INFO",
        "logger": "PerformanceLog.ServiceLog",
        "message": "END Request (GET /v2/best-company/projects/679532b9-f7f7-41ce-817f-6e58225b32b1/disciplines) with StatusCode 200; took 216 ms",
        "exception": ""
    },.....]

Get the log data between the time interval  
 GET
Resource: logs 

URLhttps://api-stage.bimplus.net/v2/logs/<startDate>/<endDate>

Examplehttps://api-stage.bimplus.net/v2/logs/20130101/20130102

OR

https://api-stage.bimplus.net/v2/logs/201301011200/201301011400

 Retrieves the log information between the mentioned time interval. The time interval could be either date based(eg: between 01.01.2013,02.01.2013) or time based (between 01.01.2013 12:00, 01.01.2013 14:00)

 

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK
[
     {
        "id": 853539,
        "server": "K2177",
        "date": "2013-12-16T10:00:23",
        "requestid": "653750b3-a97e-451f-bd01-1a4671344087",
        "thread": "51",
        "level": "INFO",
        "logger": "PerformanceLog.ServiceLog",
        "message": "BEGIN Request (GET /v2/best-company/projects/679532b9-f7f7-41ce-817f-6e58225b32b1/disciplines)",
        "exception": ""
    },
    {
        "id": 853540,
        "server": "K2177",
        "date": "2013-12-16T10:00:23",
        "requestid": "653750b3-a97e-451f-bd01-1a4671344087",
        "thread": "51",
        "level": "INFO",
        "logger": "PerformanceLog.UserLog",
        "message": "User found byId: bestcustomer@bimplus.net",
        "exception": ""
    },
    {
        "id": 853541,
        "server": "K2177",
        "date": "2013-12-16T10:00:23",
        "requestid": "653750b3-a97e-451f-bd01-1a4671344087",
        "thread": "51",
        "level": "INFO",
        "logger": "PerformanceLog.ServiceLog",
        "message": "END Request (GET /v2/best-company/projects/679532b9-f7f7-41ce-817f-6e58225b32b1/disciplines) with StatusCode 200; took 216 ms",
        "exception": ""
    },.....]

 

BTW related Service


Bimplus Teamworks is the Windows desktop application AEC professionals and BIM managers use to upload, manage and analyze building information on the Bimplus platform for use by all contributors to your construction project. For more information please see here

Get the list of logical grouping of objects which will be populated in the "Object Navigator" of BTW (Object Navigator list)
 GET
Resource: objectview 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/objectview/all

Examplehttps://api-stage.bimplus.net/v2/bimplus/on

 Get the list of logical grouping of objects which will be populated in the "Object Navigator" of BTW.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK
[
    {
        "viewname": "onProjectElements_Building",
        "resourcenameid": "Category.ElementBuilding",
        "iconid": "IconArchitectureWall",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element"
    },
    {
        "viewname": "onProjectElements_Room",
        "resourcenameid": "Category.ElementRoom",
        "iconid": "IconArchitectureRoom",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element"
    },
    {
        "viewname": "onProjectElements_Finish",
        "resourcenameid": "Category.ElementFinish",
        "iconid": "IconRoofLayer",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element"
    },
    {
        "viewname": "onProjectElements_Reinforcement",
        "resourcenameid": "Category.Reinforcement",
        "iconid": "IconReinforcement",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element"
    },
    {
        "viewname": "onProjectElements_Mesh",
        "resourcenameid": "Category.Mesh",
        "iconid": "IconMesh",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element"
    },
    {
        "viewname": "onProjectElements_Precast",
        "resourcenameid": "Category.PrecastElement",
        "iconid": "IconPrecastUnit",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element"
    },
    {
        "viewname": "onProjectElements_PrecastTimber",
        "resourcenameid": "Category.ElementPrecastTimber",
        "iconid": "IconFolder",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element"
    },
    {
        "viewname": "onProjectElements_MEP",
        "resourcenameid": "Category.ElementMEP",
        "iconid": "IconFolder",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element"
    },
    {
        "viewname": "onProjectElements_Plumbing",
        "resourcenameid": "Category.ElementPlumbing",
        "iconid": "IconFolder",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element"
    },
    {
        "viewname": "onProjectElements_Electricity",
        "resourcenameid": "Category.ElementElectricity",
        "iconid": "IconFolder",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element"
    },
    {
        "viewname": "onProjectElements_Mechanical",
        "resourcenameid": "Category.ElementMechanical",
        "iconid": "IconFolder",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element"
    },
    {
        "viewname": "onProjectElements_Construction",
        "resourcenameid": "Category.ElementConstruction",
        "iconid": "IconFolder",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element"
    },
    {
        "viewname": "onProjectElements_Terrain",
        "resourcenameid": "Category.ElementTerrain",
        "iconid": "IconFolder",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element"
    },
    {
        "viewname": "onProjectElements_Inventary",
        "resourcenameid": "Category.ElementInventary",
        "iconid": "IconFolder",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element"
    },
    {
        "viewname": "onProjectElements_Structural",
        "resourcenameid": "Category.ElementStructural",
        "iconid": "IconFolder",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element"
    },
    {
        "viewname": "onProjectElements_Clash",
        "resourcenameid": "Category.Collision",
        "iconid": "IconCollision",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Collision"
    },
    {
        "viewname": "onProjectIssues",
        "resourcenameid": "Category.Issue",
        "iconid": "IconIssue",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Issue"
    }
]

Get information about an "Object Navigator" item
 GET
Resource: objectview 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/objectview/<objectview_name>

Examplehttps://api-stage.bimplus.net/v2/bimplus/onProjectElements_Building

 Get information about an "Object Navigator" item in BTW.

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK
[
    {
        "viewname": "onProjectElements_Building",
        "resourcenameid": "Category.ElementBuilding",
        "iconid": "IconArchitectureWall",
        "sortcolumns": null,
        "projectfilter": null,
        "objectname": "Element"
    }
]

Get the properties(column names) of the "Object List"
 GET
Resource: objectview 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/<objectview_name>/tablecolumns

Examplehttps://api-stage.bimplus.net/v2/bimplus/onProjectElements_Building/tablecolumns

 Get the properties(column names) of the "Object List".

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Status: 200 OK
[
    {
        "name": "ObjectID",
        "ordernr": 1,
        "datatype": "uniqueidentifier",
        "isdefault": null,
        "categorynameid": null,
        "resourcenameid": null,
        "proporder": null,
        "converter": null,
        "browsable": "false",
        "iconid": null,
        "filterable": null
    },
    {
        "name": "Nr",
        "ordernr": 2,
        "datatype": "int",
        "isdefault": null,
        "categorynameid": "Category.General",
        "resourcenameid": null,
        "proporder": null,
        "converter": null,
        "browsable": null,
        "iconid": null,
        "filterable": null
    },
    {
        "name": "Name",
        "ordernr": 3,
        "datatype": "nvarchar",
        "isdefault": "true",
        "categorynameid": "Category.General",
        "resourcenameid": "Name",
        "proporder": null,
        "converter": "Converter_PPName",
        "browsable": null,
        "iconid": null,
        "filterable": null
    },
    {
        "name": "Description",
        "ordernr": 4,
        "datatype": "nvarchar",
        "isdefault": "true",
        "categorynameid": "Category.General",
        "resourcenameid": "Description",
        "proporder": null,
        "converter": null,
        "browsable": null,
        "iconid": null,
        "filterable": null
    },
    {
        "name": "DivisionID",
        "ordernr": 5,
        "datatype": "uniqueidentifier",
        "isdefault": null,
        "categorynameid": null,
        "resourcenameid": null,
        "proporder": null,
        "converter": null,
        "browsable": "false",
        "iconid": null,
        "filterable": null
    },
    {
        "name": "Division",
        "ordernr": 6,
        "datatype": "nvarchar",
        "isdefault": "true",
        "categorynameid": "Category.General",
        "resourcenameid": "Property.Model",
        "proporder": null,
        "converter": null,
        "browsable": null,
        "iconid": null,
        "filterable": null
    },
    {
        "name": "ModelType",
        "ordernr": 7,
        "datatype": "uniqueidentifier",
        "isdefault": "true",
        "categorynameid": "Category.General",
        "resourcenameid": "Property.Discipline",
        "proporder": null,
        "converter": "Converter_ElementType",
        "browsable": null,
        "iconid": null,
        "filterable": null
    },
    {
        "name": "ElementTyp",
        "ordernr": 8,
        "datatype": "uniqueidentifier",
        "isdefault": "true",
        "categorynameid": "Category.General",
        "resourcenameid": "Type",
        "proporder": null,
        "converter": "Converter_ElementType",
        "browsable": null,
        "iconid": null,
        "filterable": null
    },
    {
        "name": "Weight",
        "ordernr": 9,
        "datatype": "float",
        "isdefault": null,
        "categorynameid": "Category.Geometry",
        "resourcenameid": "Mass",
        "proporder": null,
        "converter": "Converter_Mass",
        "browsable": null,
        "iconid": null,
        "filterable": null
    },
    {
        "name": "Volume",
        "ordernr": 10,
        "datatype": "float",
        "isdefault": null,
        "categorynameid": "Category.Geometry",
        "resourcenameid": "Volume",
        "proporder": null,
        "converter": "Converter_Volume",
        "browsable": null,
        "iconid": null,
        "filterable": null
    },
    {
        "name": "Area",
        "ordernr": 11,
        "datatype": "float",
        "isdefault": null,
        "categorynameid": "Category.Geometry",
        "resourcenameid": "Area",
        "proporder": null,
        "converter": "Converter_Area",
        "browsable": null,
        "iconid": null,
        "filterable": null
    },
    {
        "name": "Length",
        "ordernr": 12,
        "datatype": "float",
        "isdefault": "true",
        "categorynameid": "Category.Geometry",
        "resourcenameid": "Element.Geometry.Length",
        "proporder": null,
        "converter": "Converter_Length",
        "browsable": null,
        "iconid": null,
        "filterable": null
    },
    {
        "name": "Width",
        "ordernr": 13,
        "datatype": "float",
        "isdefault": "true",
        "categorynameid": "Category.Geometry",
        "resourcenameid": "Element.Geometry.Width",
        "proporder": null,
        "converter": "Converter_Length",
        "browsable": null,
        "iconid": null,
        "filterable": null
    }
]

Get the object's details from input object list of an "Object Navigator" item
 POST
Resource: objectview/tablecontent 

URLhttps://api-stage.bimplus.net/v2/<team_slug>objectview/tablecontent 

Examplehttps://api-stage.bimplus.net/v2/bimplus/objectview/tablecontent

JSON Structure

Name

Mandatory / Optional

Type

Description

tablename

mandatory

string

Name of the table

elementsguid

mandatory

List

List of object id's whose details has to be found


 Get the object's details from input object list of an "Object Navigator" item
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
{
    "tablename": "onProjectElements_Building",
    "elementsguid": [
        "1F3E2F56-A94F-4486-97F5-21ACDF7A76AE",
        "54978C4C-B18B-4420-819D-405234FC11B4",
        "EB0472BE-1353-4E47-BE76-875924E0586F"
    ]
}
Status: 200 OK
[
    {
        "objectid": "1f3e2f56-a94f-4486-97f5-21acdf7a76ae",
        "divisionid": "06a78b8f-c692-46d1-a16e-f878b6a86f17",
        "nr": 0,
        "name": "Wall",
        "description": null,
        "division": "clash",
        "modeltype": "0f106af0-a919-44c5-b211-15bd5ef620b6",
        "elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
        "weight": 0,
        "volume": 0,
        "area": 0,
        "length": 0,
        "width": 300
    },
    {
        "objectid": "54978c4c-b18b-4420-819d-405234fc11b4",
        "divisionid": "06a78b8f-c692-46d1-a16e-f878b6a86f17",
        "nr": 0,
        "name": "Wall",
        "description": null,
        "division": "clash",
        "modeltype": "0f106af0-a919-44c5-b211-15bd5ef620b6",
        "elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
        "weight": 0,
        "volume": 0,
        "area": 0,
        "length": 0,
        "width": 300
    },
    {
        "objectid": "eb0472be-1353-4e47-be76-875924e0586f",
        "divisionid": "06a78b8f-c692-46d1-a16e-f878b6a86f17",
        "nr": 0,
        "name": "Wall",
        "description": null,
        "division": "clash",
        "modeltype": "0f106af0-a919-44c5-b211-15bd5ef620b6",
        "elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
        "weight": 0,
        "volume": 0,
        "area": 0,
        "length": 0,
        "width": 300
    }
]

Get all the user hierarchies using the user & module information
 POST
Resource: usersettings/heirarchy/all 

URLhttps://api-stage.bimplus.net/v2/<team_slug>usersettings/heirarchy/all 

Examplehttps://api-stage.bimplus.net/v2/bimplus/usersettings/heirarchy/all

JSON Structure

Name

Mandatory / Optional

Type

Description

moduleid

mandatory

guid

Id of the module

userid

mandatory

guid

Id of the user

categoryoptionalstringcategory name (default category is "ObjectNavigator")


 Get all the user hierarchies using the user & module information
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
{
    "moduleid": "3e3b1ae3-8955-4c4e-803e-2d56a4a8e50d",
    "userid": "a612e213-1a6e-4aa2-b032-d5aeb8f31c97",
    "category": "ObjectNavigator"
}
Status: 200 OK
[
    {
        "attribusersettingid": "511d2c35-d7a6-4e76-82f0-172a64c322b6",
        "objectid": "1f15c447-e511-4fc1-940b-13639f973c52",
        "module": "3e3b1ae3-8955-4c4e-803e-2d56a4a8e50d",
        "userid": "a612e213-1a6e-4aa2-b032-d5aeb8f31c97",
        "category": "ObjectNavigator",
        "isdefault": false,
        "valuekey": "[onProjectElements_Building]",
        "valuename": "onProjectElements_Building",
        "value": "Name[I]Description[I]Division[I]ModelType[I]ElementTyp[I]Length[I]Width",
        "datasmallint": null,
        "revision": null
    },
    {
        "attribusersettingid": "909c9802-a339-4a60-8fff-64ea495f6136",
        "objectid": "1f15c447-e511-4fc1-940b-13639f973c52",
        "module": "3e3b1ae3-8955-4c4e-803e-2d56a4a8e50d",
        "userid": "a612e213-1a6e-4aa2-b032-d5aeb8f31c97",
        "category": "ObjectNavigator",
        "isdefault": false,
        "valuekey": "[onProjectElements_Electricity]",
        "valuename": "onProjectElements_Electricity",
        "value": "Name[I]Description[I]Division[I]ModelType[I]ElementTyp[I]Length[I]Width",
        "datasmallint": null,
        "revision": null
    },
    {
        "attribusersettingid": "e4ca5278-98da-4809-9582-6815bbab2200",
        "objectid": "1f15c447-e511-4fc1-940b-13639f973c52",
        "module": "3e3b1ae3-8955-4c4e-803e-2d56a4a8e50d",
        "userid": "a612e213-1a6e-4aa2-b032-d5aeb8f31c97",
        "category": "ObjectNavigator",
        "isdefault": false,
        "valuekey": "[onProjectElements_MEP]",
        "valuename": "onProjectElements_MEP",
        "value": "Name[I]Description[I]Division[I]ModelType[I]ElementTyp[I]Weight[I]Length[I]Width",
        "datasmallint": 0,
        "revision": null
    }
]