4.2 Project Service

Project Service

A Project is basically a holder which contains building models.

Create a new project

Resource: projects

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

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

JSON Structure:

Name	Mandatory / Optional	Type	Description
id	will be ignored	string (guid)	Id of the project
name	mandatory	string	Name of the project
shortDescr	optional	string	Short description of the project
teamName	will be ignored	string	Name of the team to which the project belongs
teamSlug	will be ignored	string	Slug of the team to which the project belongs
hasWriteAccess	will be ignored	boolean	Don't use this property. This property is not deleted to support the older clients
thumbnail	will be ignored	string	Direct download link to project thumbnail
created	will be ignored	string (date)	Creation date of the project
createdBy	will be ignored	JSON object	Details of the Bimplus user who has created the project
changed	will be ignored	string(date)	Modified date of the project
changedBy	will be ignored	JSON object	Details of the Bimplus user who has created the project
address	optional	string	Address of the project
modelCount	will be ignored	int	Number of models in this project
memberCount	will be ignored	int	Number of members in this project
topicCount	will be ignored	int	Number of topics in this project
attachmentCount	will be ignored	int	Number of attachments in this project
size	will be ignored	int	Size of the project in bytes
sizeInMB	will be ignored	string	Size of the project in MB
disciplines	will be ignored	JSON object	Disciplines found under this project
rights	will be ignored	JSON object	The rights the user has for this project

POST

Creates a new project.

Headers

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

JSON

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

Status

Status: 201 Created

JSON

{
    "name": "Your Awesome Building",
    "shortDescr": "Example for creating a project",
    "teamName": "Best Company",
    "teamSlug": "best-company",
    "hasWriteAccess" : true,
    "thumbnail": null,
    "created": "2013-06-01T10:05:00",
    "createdby" : {
        "id": "7c555899-5a5f-44d1-930e-284930678bed",
        "email" : "testuser@bimplus.net"
    },
    "changed": "2013-06-01T10:05:00",
    "changedby" : {
        "id": "7c555899-5a5f-44d1-930e-284930678bed",
        "email" : "testuser@bimplus.net"
    },
    "address" : "My address somewhere",
    "modelCount": 0,
    "memberCount": 1,
    "topicCount": 0,
    "attachmentCount": 0,
    "size": 0,
    "sizeMB": "0",
    "id": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
}

Get the logged in user's project List

Resource: projects

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

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

GET

Gets the entire list of projects in which the logged in user is a member

Headers

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

Status

Status: 200 OK

JSON

[
    {
        "id": "586b02be-43b8-4e27-b698-e067e85e38e2",
        "name": "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang",
        "shortDescr": "Hey, i am your favourite test entry",
        "thumbnail": "",
        "created": "2013-05-01T09:33:18",
        "createdby" : {
            "id" : "f4b1178d-385f-449c-a2a7-6f58b264d90c"
            "email" : "owner@company1.com",
        },
        "changed": "2013-05-01T09:33:18",
        "changedby" : {
            "id" : "f4b1178d-385f-449c-a2a7-6f58b264d90c"
            "email" : "owner@company1.com",
        },
        "address" : "Address of company 1"
        "hasWriteAccess": false,
        "teamSlug": "company1",
        "modelCount" : 3,
        "memberCount" : 3,
        "size" : 63488,
        "sizeMB" : "0.06",
        "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": "",
        "created": "0001-01-01T00:00:00",
        "createdby" : {
            "id": "7c555899-5a5f-44d1-930e-284930678bed",
            "email" : "testuser@bimplus.net"
        },
        "changed": "0001-01-01T00:00:00",
        "changedby" : {
            "id": "7c555899-5a5f-44d1-930e-284930678bed",
            "email" : "testuser@bimplus.net"
        },
        "address" : "My address somewhere",
        "hasWriteAccess": true,
        "teamSlug": "best-company",
        "modelCount": 4,
        "memberCount": 2,
        "size" : 4263936,
        "sizeMB" : "4,07",
        "rights": {
            "projectAdmin": true,
            "projectDelete": true,
            "projectEdit": true,
            "modelsCreate": true,
            "modelsViewAll": true
        }
    }
]

Get the user's project list from a team

Resource: projects

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

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

GET

Gets the project list with main properties from a particular team in which the user is a member of.

Headers

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

Status

Status: 200 OK

JSON

[
    {
        "id": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
        "name": "Your Awesome Building",
        "shortDescr": "Example for creating a project",
        "thumbnail": "",
        "created": "0001-01-01T00:00:00",
        "createdby" : {
            "id": "7c555899-5a5f-44d1-930e-284930678bed",
            "email" : "testuser@bimplus.net"
        },
        "changed": "0001-01-01T00:00:00",
        "changedby" : {
            "id": "7c555899-5a5f-44d1-930e-284930678bed",
            "email" : "testuser@bimplus.net"
        },
        "address" : "My address somewhere",
        "hasWriteAccess": true,
        "teamSlug": "best-company",
        "modelCount": 4,
        "memberCount": 2,
        "size" : 4263936,
        "sizeMB" : "4,07",
        "rights": {
            "projectAdmin": true,
            "projectDelete": true,
            "projectEdit": true,
            "modelsCreate": true,
            "modelsViewAll": true
        }
    },
    {
        "id": "4e87944a-a477-4e4c-862e-e723dcb43066",
        "name": "UC_Fly-over Kerensheide",
        "shortDescr": "",
        "thumbnail": "",
        "created": "2013-05-10T07:13:38",
        "createdby" : {
            "id": "bda91f09-2cc6-45da-bba0-5f92828f58bc",
            "email" : "UserA@bimplus.net"
        },
        "changed": "2013-05-16T07:34:56",
        "changedby" : {
            "id": "7c555899-5a5f-44d1-930e-284930678bed",
            "email" : "testuser@bimplus.net"
        },
        "address" : ""
        "hasWriteAccess": true,
        "teamSlug": "best-company",
        "modelCount": 2,
        "memberCount": 3,
        "size": 63488,
        "sizeMB": "0,06",
        "rights": {
            "projectAdmin": false,
            "projectDelete": false,
            "projectEdit": true,
            "modelsCreate": false,
            "modelsViewAll": true
        }
    }
]

Get the Project Properties

Resource: projects/<project_id>

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

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

GET

Get all the project properties of a project using its id.

Headers

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

Status

Status: 200 OK

JSON

{  
	"name" : "Your Awesome Building",
	"shortDescr" : "Example for creating a project"    
	"teamName": "jay-company",
    "teamSlug": "jay-company",
    "hasWriteAccess": true,
    "thumbnail": "/jay-company/projects/de87fc4d-cb5d-44ba-b2ea-1d96ac564a8a/thumbnail/download",
    "created": "2014-02-14T09:48:27",
    "createdby": {
        "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
        "email": "jayaraj.purushothaman@gmail.com"
    },
    "changed": "2015-11-19T09:45:51",
    "changedby": {
        "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
        "email": "jayaraj.purushothaman@gmail.com"
    },
    "address": "",
    "modelCount": 1,
    "memberCount": 7,
    "topicCount": 30,
    "attachmentCount": 13,
    "size": 99317760,
    "sizeMB": "94,72",
    "disciplines": [
        {
            "id": "0f106af0-a919-44c5-b211-15bd5ef620b6",
            "name": "ID_BuildingModel",
            "divisionId": "b539790e-2ffc-43cd-9582-b4aa27b36693",
            "divisionName": "Model1",
            "divisionTopologyId": "25f38274-7158-436d-9356-f5c917ee44c9",
            "revisions": [
                1
            ],
            "visible": false,
            "opaque": false,
            "opacity": 0
        },
        {
            "id": "30114b52-bc05-47c1-80b5-c7d5485d5840",
            "name": "ID_FinishModel",
            "divisionId": "b539790e-2ffc-43cd-9582-b4aa27b36693",
            "divisionName": "Model1",
            "divisionTopologyId": "25f38274-7158-436d-9356-f5c917ee44c9",
            "revisions": [
                1,2
            ],
            "visible": false,
            "opaque": false,
            "opacity": 0
        },
        {
            "id": "09e623d4-1e12-4a77-b358-ea1d0b28e4a7",
            "name": "ID_RoomModel",
            "divisionId": "b539790e-2ffc-43cd-9582-b4aa27b36693",
            "divisionName": "Model1",
            "divisionTopologyId": "25f38274-7158-436d-9356-f5c917ee44c9",
            "revisions": [
                1
            ],
            "visible": false,
            "opaque": false,
            "opacity": 0
        }
    ],
    "rights": {
        "projectAdmin": true,
        "projectDelete": true,
        "projectEdit": true,
        "modelsCreate": true,
        "modelsViewAll": true
    },
    "id": "5cd37c77-d341-4ab2-9f0d-44467955b218"
}

Update the project

Resource: projects/<project_id>

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

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

JSON Structure:

Name	Mandatory / Optional	Type	Description
id	will be ignored	string (guid)	Id of the project
name	mandatory	string	Name of the project
shortDescr	optional	string	Short description of the project
teamName	will be ignored	string	Name of the team to which the project belongs
teamSlug	will be ignored	string	Slug of the team to which the project belongs
hasWriteAccess	will be ignored	boolean	Don't use this property. This property is not deleted to support the older clients
created	will be ignored	string (date)	Creation date of the project
createdBy	will be ignored	JSON object	Details of the Bimplus user who has created the project
changed	will be ignored	string(date)	Modified date of the project
changedBy	will be ignored	JSON object	Details of the Bimplus user who has created the project
address	optional	string	Address of the project
modelCount	will be ignored	int	Number of models in this project
memberCount	will be ignored	int	Number of members in this project
topicCount	will be ignored	int	Number of topics in this project
attachmentCount	will be ignored	int	Number of attachments in this project
size	will be ignored	int	Size of the project in bytes
sizeInMB	will be ignored	string	Size of the project in MB
disciplines	will be ignored	JSON object	Disciplines found under this project
rights	will be ignored	JSON object	The rights the user has for this project

PUT

Update properties of the specified project.

Headers

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

JSON

{
    "name" : "Your Awesome Building updated",
	"shortDescr" : "Example for updating a project",
    "address": "Changed address",
}

Status

Status: 200 OK

JSON

{
    "name" : "Your Awesome Building updated",
	"shortDescr" : "Example for updating a project",
    "teamName": "Best Company",
    "teamSlug": "best-company",
    "hasWriteAccess" : true,
    "thumbnail": null,
    "created": "2013-06-01T10:05:00",
    "createdby" : {
        "id": "7c555899-5a5f-44d1-930e-284930678bed",
        "email" : "testuser@bimplus.net"
    },
    "changed": "2013-06-02T10:04:15",
    "changedby" : {
        "id": "7c555899-5a5f-44d1-930e-284930678bed",
        "email" : "testuser@bimplus.net"
    },
    "address" : "Changed address",
    "modelCount": 0,
    "memberCount": 1,
    "topicCount": 0,
    "attachmentCount": 0,
    "size": 0,
    "sizeMB": "0",
    "id": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
}

Create an issue in the project with a view

Resource: projects/<project_id>issues

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

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

JSON Structure:

Name	Mandatory / Optional	Type	Description
shortId	will be ignored	number	Readable unique issue number (always starts with 1 for each project)
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
responsible	optional	object	Responsible 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
tag	optional	string	custom classification
modifiedAt	optional	string	Modified date of the issue
scene	optional	Fixed template	Scene/View of this topic. The pre-defined template is present here

POST

Creates a new issue in a project. While creating an issue in a project, a view of an object can be created & included as a property in the topic similar to the Slideshow. This is similar to creating slides & the template for creating slides is present here

Headers

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

JSON

{
    "name": "Wall info wrong",
    "author": {
        "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
        "email": "jayaraj.purushothaman@gmail.com",
        "status": "Active",
        "firstname": "Jayaraj",
        "lastname": "Purushothaman",
        "company": "Jay Company",
        "fullname": "Jayaraj Purushothaman",
        "displayname": "Jayaraj Purushothaman [Jay Company]",
        "info": null,
        "gender": "MR",
        "phoneWork": null,
        "phoneHome": null,
        "fax": null,
        "mobile": "",
        "birthDate": null,
        "address": {
            "street": "",
            "streetNr": "",
            "zip": "",
            "city": "",
            "country": ""
        },
        "preferedLanguage": "en"
    },
    "responsible": {
        "id": "6e67ba07-50c3-d51d-23f0-3ac0d8788202",
        "email": "jayaraj.purushothaman@bimplus.net",
        "status": "Active",
        "firstname": "Jayaraj",
        "lastname": "Purushothaman",
        "company": "Bimplus GmbH",
        "fullname": "Jayaraj Purushothaman",
        "displayname": "Jayaraj Purushothaman [Bimplus GmbH]",
        "info": null,
        "gender": "MR",
        "phoneWork": null,
        "phoneHome": null,
        "fax": null,
        "mobile": "",
        "birthDate": null,
        "address": {
            "street": "",
            "streetNr": "",
            "zip": "",
            "city": "",
            "country": ""
        },
        "preferedLanguage": "de"
    },
    "scene": null,
    "attachmentsCount": 0,
    "pinsCount": 4,
    "commentsCount": 1,
    "hyperlinksCount": 0,
    "shortId": 1,
    "projectId": "5cd37c77-d341-4ab2-9f0d-44467955b218",
    "description": "test1",
    "status": "Open",
    "createdAt": "2014-05-09T10:15:24+02:00",
    "modifiedAt": "2015-07-30T07:04:27+02:00",
    "dueDate": null,
    "solution": null,
    "type": "Remark",
    "classification": null,
    "priority": "Medium",
    "cc": [
        "ssudha84@gmail.com",
        "rush2jayaraj@yahoo.co.in"
    ],
    "clashId": "70d07604-cf68-4d94-abc0-c783f8cc548b",
    "id": "5eac4d92-c65b-49c8-927c-9f255879a5c2"
}

Status

Status: 201 Created

JSON

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

Resource: projects/<project_id>issues

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

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

GET

Get all the issues assigned to a specified project.

Headers

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

Status

Status: 200 OK

JSON

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

Resource: projects/<project_id>issues

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

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

DELETE

Delete all the issues belonging to a specified project.

Headers

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

Status

Status: 200 OK

Create a new attachment in the project

Resource: projects/<project_id>/attachments

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

Example: https://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	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
sizeInMB	optional	integer	Size of the file to be attached to the project
createdAt	will be ignored	string	Creation date of the attachment
creator	will be ignored	object	The user who created the attachment
attachmentType	will be ignored	string	Type of attachment. It could be one of the following : Thumbnail, Ifc, SketchUp, AllplanResource, AllplanDrawing, AllplanLayout, AllplanLayoutDocument, AutodeskResource, Revit, AutoCadDrawing Please note that there exists a filter for it. See the filter section
classification	optional	string	Classify the attachments. The existing classifications are : Plan, Cost, Contract, Drawing , Specification, Report, Image
tag	optional	string	User defined classification (We will change this to a list later)

POST

Creates a new attachment in a project.

Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: multipart/form-data

Status

Status: 201 Created

JSON

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

Resource: projects/<project_id>/attachments

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

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

GET

Get all the attachments belonging to a specified project. The normal attachment GET call (i.e projects/<project_id>/attachments) returns all the attachments inside a project i.e it iterates through all the objects inside a project and returns everything. If we want to retrieve the only the attachments that belongs to the project directly, then use ?projectOnly=true filter (i.e projects/<project_id>/attachments?projectOnly=true)

Headers

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

Status

Status: 200 OK

JSON

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

Resource: projects/<project_id>/attachments

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

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

DELETE

Delete all the attachments belonging to a specified project.

Headers

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

Status

Status: 200 OK

Get the project topology tree

Resource: projects/<project_id>/topology

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

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

GET

Get the project topology tree.

Headers

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

Status

Status: 200 OK

JSON

{
    "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 spot list from the project

Resource: projects/<project_id>/pins

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

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

GET

Get the spot list from the project

Headers

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

Status

Status: 200 OK

JSON

[
    {
        "issueId": "5eac4d92-c65b-49c8-927c-9f255879a5c2",
        "objectId": "442af981-4175-4f1d-90f0-ef1c8641f0cb",
        "topologyNodeId": "4be5ffd3-1e5e-42a7-9844-23b55fb39253",
        "position": {
            "x": 78696.44,
            "y": 9652.251,
            "z": 580
        },
        "normalVector": {
            "x": 0,
            "y": 0,
            "z": 1
        },
        "createdAt": "2014-05-09T12:17:18",
        "id": "3ba43939-5805-4aac-b7a5-8cf3b5833ac3"
    },
    {
        "issueId": "5333bb42-2cb9-4f11-afd8-120c79edef37",
        "objectId": "ae1a139a-1e13-491f-b6d8-a46f699e295e",
        "topologyNodeId": "37a26e8b-566e-4d6e-8ab2-f35a715e83e2",
        "position": {
            "x": 41677.4336,
            "y": 10095.9512,
            "z": -9020
        },
        "normalVector": {
            "x": 0,
            "y": 0,
            "z": 1
        },
        "createdAt": "2014-05-09T12:17:33",
        "id": "fa9acf26-efdf-4297-80b5-2422bbf6e35a"
    },
    {
        "issueId": "5eac4d92-c65b-49c8-927c-9f255879a5c2",
        "objectId": "effc5f9f-dcae-4e5f-9a67-189d4a285612",
        "topologyNodeId": "4be5ffd3-1e5e-42a7-9844-23b55fb39253",
        "position": {
            "x": -440,
            "y": 10767.11,
            "z": -8243.917
        },
        "normalVector": {
            "x": -1,
            "y": 0,
            "z": 0
        },
        "createdAt": "2014-05-27T08:56:46",
        "id": "a014fcf3-c72e-4def-bc41-58b349b31591"
    },
    {
        "issueId": "5333bb42-2cb9-4f11-afd8-120c79edef37",
        "objectId": "367af808-de74-41b4-a3fb-1bfb50559da3",
        "topologyNodeId": "9fc99e93-2f33-4247-b3a4-2a6658a9b750",
        "position": {
            "x": 22525.0254,
            "y": 10334.1377,
            "z": -9172
        },
        "normalVector": {
            "x": 0,
            "y": 0,
            "z": 1
        },
        "createdAt": "2014-05-21T13:34:07",
        "id": "2b693990-a611-4b05-9efd-7485a9aeebbb"
    },
    {
        "issueId": "5eac4d92-c65b-49c8-927c-9f255879a5c2",
        "objectId": "83821c97-0020-480e-b863-9981df590c0a",
        "topologyNodeId": "aa7e1b6f-7324-459b-a114-9833806f89ed",
        "position": {
            "x": 664.999939,
            "y": 7197.733,
            "z": -58535.82
        },
        "normalVector": {
            "x": -1,
            "y": 0,
            "z": 0
        },
        "createdAt": "2014-05-27T09:18:17",
        "id": "f2a9c63f-2514-4c1f-be78-758a984b5430"
    }
]

Get the project disciplines

Resource: projects/<project_id>/disciplines

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

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

GET

Get the layers of a project.

Headers

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

Status

Status: 200 OK

JSON

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

Resource: projects/<project_id>/thumbnail

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

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

POST

Creates or uploads a thumbnail to the project.

Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: multipart/form-data

Thumbnail API call:

Status

Status: 201 Created

JSON

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

Download the thumbnail

Resource: thumbnail/<thumbnail_id>

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

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

GET

Downloads the thumbnail.

Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: multipart/form-data

Status

Status: 200 OK

Get the structure list from a project

Resource: structures/<structure_id>

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

Example:https://api-stage.bimplus.net/v2/bimplus/projects/179439d6-df16-41cc-bd2c-74d05b7995d5/structures

GET

Get the structure list from a project

Headers

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

Status

Status: 200 OK

JSON

[
    {
        "name": "TestStructure",
        "description": "FullLifeCycleTest",
        "type": "CostStructure",
        "nr": 1,
        "color": 0,
        "id": "179439d6-df16-41cc-bd2c-74d05b7995d5"
    },
    {
        "name": "TestStructure2",
        "description": "Another Structure",
        "type": "SpecificationStructure",
        "nr": 2,
        "color": 0,
        "id": "279439d6-df16-41cc-bd2c-74d05b7995d5"
    }
]

Delete all the structures from a project

Resource: projects/<project_id>/structures

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

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

DELETE

Deletes all the structures from a specified project

Headers

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

Status

Status: 200 OK

Get the topology of all structures belonging to a project

Resource: structures/<project_id>/topology

URL: https://api-stage.bimplus.net/v2/<team_slug>/structures/<project_id>/topology

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

GET

Get the topology of all structures belonging to a specified project

Headers

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

Status

Status: 200 OK

JSON

{
    "parent": null,
    "name": "Test for Structure",
    "type": "ID_Project",
    "children": [
        {
            "parent": "622272da-f1ff-45ab-a3f0-c8f1255c80e8",
            "name": "TestStructure",
            "type": "Structure",
            "children": [
                {
                    "parent": "179439d6-df16-41cc-bd2c-74d05b7995d5",
                    "name": "Node 1",
                    "type": "Structure",
                    "children": [
                        {
                            "parent": "adf506ae-3628-4501-9af1-22bcf27e4ab4",
                            "name": "WallConnection",
                            "type": "StructureElement",
                            "children": [
                                {
                                    "parent": "35b986c2-e9cd-482e-9281-6000671a49f0",
                                    "name": "Wall-005",
                                    "type": "ID_ArchWall",
                                    "children": [],
                                    "id": "df4a81d6-42fb-4187-bbce-82a2fc093b2f"
                                }
                            ],
                            "id": "35b986c2-e9cd-482e-9281-6000671a49f0"
                        }
                    ],
                    "id": "adf506ae-3628-4501-9af1-22bcf27e4ab4"
                }
            ],
            "id": "179439d6-df16-41cc-bd2c-74d05b7995d5"
        }
    ],
    "id": "622272da-f1ff-45ab-a3f0-c8f1255c80e8"
}

Get all the comments, hyperlinks from the project

Resource: comments, hyperlinks

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

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

GET

Get all the comments, hyperlinks from the project

Headers

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

Status

Status: 200 OK

JSON

{
    "parent": null,
    "name": "Test for Structure",
    "type": "ID_Project",
    "children": [
        {
            "parent": "622272da-f1ff-45ab-a3f0-c8f1255c80e8",
            "name": "TestStructure",
            "type": "Structure",
            "children": [
                {
                    "parent": "179439d6-df16-41cc-bd2c-74d05b7995d5",
                    "name": "Node 1",
                    "type": "Structure",
                    "children": [
                        {
                            "parent": "adf506ae-3628-4501-9af1-22bcf27e4ab4",
                            "name": "WallConnection",
                            "type": "StructureElement",
                            "children": [
                                {
                                    "parent": "35b986c2-e9cd-482e-9281-6000671a49f0",
                                    "name": "Wall-005",
                                    "type": "ID_ArchWall",
                                    "children": [],
                                    "id": "df4a81d6-42fb-4187-bbce-82a2fc093b2f"
                                }
                            ],
                            "id": "35b986c2-e9cd-482e-9281-6000671a49f0"
                        }
                    ],
                    "id": "adf506ae-3628-4501-9af1-22bcf27e4ab4"
                }
            ],
            "id": "179439d6-df16-41cc-bd2c-74d05b7995d5"
        }
    ],
    "id": "622272da-f1ff-45ab-a3f0-c8f1255c80e8"
}

Delete the project

Resource: projects/<project_id>

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

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

DELETE

Deletes a specified project.

Headers

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

Status

Status: 200 OK

{"name":"Nemetschek","shortDescr":"description\n","teamName":"jay-company","teamSlug":"jay-company","hasWriteAccess":true,"thumbnail":"","created":"2014-02-14T09:48:27","createdby":{"id":"71e0ac3b-fa49-e540-ac2f-8caff3dd72ed","email":"jayaraj.purushothaman@gmail.com"},"changed":"2015-11-19T09:45:51","changedby":{"id":"71e0ac3b-fa49-e540-ac2f-8caff3dd72ed","email":"jayaraj.purushothaman@gmail.com"},"address":"","modelCount":1,"memberCount":7,"topicCount":30,"attachmentCount":13,"size":0,"sizeMB":"0","disciplines":[{"id":"0f106af0-a919-44c5-b211-15bd5ef620b6","name":"ID_BuildingModel","divisionId":"b539790e-2ffc-43cd-9582-b4aa27b36693","divisionName":"Model1","divisionTopologyId":"25f38274-7158-436d-9356-f5c917ee44c9","revisions":[1],"visible":false,"opaque":false,"opacity":0.0},{"id":"30114b52-bc05-47c1-80b5-c7d5485d5840","name":"ID_FinishModel","divisionId":"b539790e-2ffc-43cd-9582-b4aa27b36693","divisionName":"Model1","divisionTopologyId":"25f38274-7158-436d-9356-f5c917ee44c9","revisions":[1],"visible":false,"opaque":false,"opacity":0.0},{"id":"09e623d4-1e12-4a77-b358-ea1d0b28e4a7","name":"ID_RoomModel","divisionId":"b539790e-2ffc-43cd-9582-b4aa27b36693","divisionName":"Model1","divisionTopologyId":"25f38274-7158-436d-9356-f5c917ee44c9","revisions":[1],"visible":false,"opaque":false,"opacity":0.0}],"rights":{"projectAdmin":true,"projectDelete":true,"projectEdit":true,"modelsCreate":true,"modelsViewAll":true},"id":"5cd37c77-d341-4ab2-9f0d-44467955b218"}

Math Editor

Space shortcuts

Page tree

Project Service

Project Service

Create a new project

Get the logged in user's project List

Get the user's project list from a team

Get the Project Properties

Update the project

Create an issue in the project with a view

Get the Issue List from the project

Delete all the issues from the project

Create a new attachment in the project

Get the Attachment List from the project

Delete all the attachments from the project

Get the project topology tree

Get the spot list from the project

Get the project disciplines

Create / Upload a thumbnail to the project

Download the thumbnail

Get the structure list from a project

Delete all the structures from a project

Get the topology of all structures belonging to a project

Get all the comments, hyperlinks from the project

Delete the project