Page History

...

Anchor

	projectService
	projectService

Project Service

...

A Project is basically a holder which contains building models.

Anchor

	createProject
	createProject

Create a new project

Deck of Cards

id	bimCreateProject

Card

label	URL / Resource / JSON Structure

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

Card

label	HTTP Method

POST

Card

default	true
label	Description

Creates a new project.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Code Block

borderColor	Red
title	JSON
lang	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 201 Created

Code Block

borderColor	Red
title	JSON
lang	xml

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

Anchor

	getCurrentProjectList
	getCurrentProjectList

Get the logged in user's project List

Deck of Cards

id	bimGetCurrentProjectList

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects

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

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

Card

label	HTTP Method

GET

Card

label	Description

Gets the whole project list in which the logged in user has a project role

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

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

Anchor

	getProjectList
	getProjectList

Get the user's project list from a team

Deck of Cards

id	bimGetProjectList

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects

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

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

Card

label	HTTP Method

GET

Card

label	Description

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

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

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

Anchor

	getProjectProp
	getProjectProp

Get the Project Properties

Deck of Cards

id	bimGetProjectProp

Card

default	true
label	URL / Resource / JSON Structure

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

Card

label	HTTP Method

GET

Card

label	Description

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

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

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

Anchor

	updateProject
	updateProject

Update the project

Deck of Cards

id	bimUpdateProject

Card

default	true
label	URL / Resource / JSON Structure

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

Card

label	HTTP Method

PUT

Card

label	Description

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

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Code Block

borderColor	Red
title	JSON
lang	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Anchor

	createIssueInProject
	createIssueInProject

Create an issue in the project

Deck of Cards

id	bimCreateIssue

Card

default	true
label	URL / Resource / JSON Structure

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

Card

label	HTTP Method

POST

Card

label	Description

Creates a new issue in a project. While creating an issue in a project, the view of the model is automatically saved.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Code Block

borderColor	Red
title	JSON
lang	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 201 Created

Code Block

borderColor	Red
title	JSON
lang	xml

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

Anchor

	getIssueList
	getIssueList

Get the Issue List from the project

Deck of Cards

id	bimGetIssueListFromProject

Card

default	true
label	URL / Resource / JSON Structure

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

Card

label	HTTP Method

GET

Card

label	Description

Get all the issues assigned to a specified project.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

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

Anchor

	deleteIssues
	deleteIssues

Delete all the issues from the project

Deck of Cards

id	bimDeleteIssueListFromProject

Card

default	true
label	URL / Resource / JSON Structure

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

Card

label	HTTP Method

DELETE

Card

label	Description

Delete all the issues belonging to a specified project.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Anchor

	createAttachment
	createAttachment

Create a new attachment in the project

Deck of Cards

id	bimCreateAttachmentInProject

Card

default	true
label	URL / Resource / JSON Structure

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	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
createdAt	will be ignored	string	Creation time of the attachment
creator	will be ignored	object	The user who created the attachment

Card

label	HTTP Method

POST

Card

label	Description

Creates a new attachment in a project.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Image Added

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 201 Created

Code Block

borderColor	Red
title	JSON
lang	xml

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

Anchor

	getAttachments
	getAttachments

Get the Attachment List from the project

Deck of Cards

id	bimGetAttachmentListFromProject

Card

default	true
label	URL / Resource / JSON Structure

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

Card

label	HTTP Method

GET

Card

label	Description

Get all the attachments belonging to a specified project.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

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

Anchor

	deleteAttachments
	deleteAttachments

Delete all the attachments from the project

Deck of Cards

id	bimDeleteAttachmentListFromProject

Card

default	true
label	URL / Resource / JSON Structure

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

Card

label	HTTP Method

DELETE

Card

label	Description

Delete all the attachments belonging to a specified project.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Anchor

	getProjectTopology
	getProjectTopology

Get the project topology tree

Deck of Cards

id	bimGetProjectTopology

Card

default	true
label	URL / Resource / JSON Structure

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

Card

label	HTTP Method

GET

Card

label	Description

Get the project topology tree.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

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

Anchor

	getSpotListFromProject
	getSpotListFromProject

Get the spot list from the project

Deck of Cards

id	bimGetSpotListFromProject

Card

default	true
label	URL / Resource / JSON Structure

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

Card

label	HTTP Method

GET

Card

label	Description

Get the spot list from the project

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

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

Anchor

	getProjectDisciplines
	getProjectDisciplines

Get the project disciplines

Deck of Cards

id	bimGetProjectDisc

Card

default	true
label	URL / Resource / JSON Structure

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

Card

label	HTTP Method

GET

Card

label	Description

Get the layers of a project.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

[
    {
        "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": []
    }
]

Anchor

	createThumbnail
	createThumbnail

Create / Upload a thumbnail to the project

Deck of Cards

id	bimCreateThumbnail

Card

default	true
label	URL / Resource / JSON Structure

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

Card

label	HTTP Method

POST

Card

label	Description

Creates or uploads a thumbnail to the project.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Thumbnail API call:

Image Added

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 201 Created

Code Block

borderColor	Red
title	JSON
lang	xml

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

Anchor

	downloadThumbnail
	downloadThumbnail

Download the thumbnail

Deck of Cards

id	bimDownloadThumbnailOfProject

Card

default	true
label	URL / Resource / JSON Structure

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

Card

label	HTTP Method

GET

Card

label	Description

Downloads the thumbnail.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Anchor

	getStructureList
	getStructureList

Get the structure list from a project

Deck of Cards

id	bimGetStructureDetails

Card

default	true
label	URL / Resource / JSON Structure

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

Card

label	HTTP Method

GET

Card

label	Description

Get the structure list from a project

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

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

Anchor

	deleteStructureList
	deleteStructureList

Delete all the structures from a project

Deck of Cards

id	bimDeleteStructureList

Card

default	true
label	URL / Resource / JSON Structure

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

Card

label	HTTP Method

DELETE

Card

label	Description

Deletes all the structures from a specified project

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Anchor

	getStructureTopologyProject
	getStructureTopologyProject

Get the topology of all structures belonging to a project

Deck of Cards

id	bimGetStructureTopologyProject

Card

default	true
label	URL / Resource / JSON Structure

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

Card

label	HTTP Method

GET

Card

label	Description

Get the topology of all structures belonging to a specified project

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

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

Anchor

	deleteProject
	deleteProject

Delete the project

Deck of Cards

id	bimDeleteProject

Card

default	true
label	URL / Resource / JSON Structure

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

Card

label	HTTP Method

DELETE

Card

label	Description

Deletes a specified project.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 5

New Version 6

Key

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

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

Delete the project