Page History

...

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 TraufeingangYour Awesome Building",
    	"shortDescr" : "Hey, i am your favourite test entryExample for creating a project"    
	"teamName": "jay-company",
    "thumbnailteamSlug": null"jay-company",
    "createdhasWriteAccess": nulltrue,
    "changedthumbnail": null"",
    "disciplinescreated": ["2014-02-14T09:48:27",
       "createdby": {
            "id": "0f106af071e0ac3b-a919fa49-44c5e540-b211ac2f-15bd5ef620b68caff3dd72ed",
            "nameemail": "ID_BuildingModel",jayaraj.purushothaman@gmail.com"
    },
        "divisionId": "ac21b9a1-8853-4658-9fbf-0cf62340bd18"changed": "2015-11-19T09:45:51",
    "changedby": {
        "divisionNameid": null"71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "revisionsemail": []
"jayaraj.purushothaman@gmail.com"
    },
     }"address": "",
    "modelCount": 1,
   {
 "memberCount": 7,
      "topicCount": 30,
    "idattachmentCount": "63b069d2-81df-4418-91de-8a954fa12924"13,
        "size": 0,
    "namesizeMB": "ID_DesignModel_Timber0",
     "disciplines": [
       "divisionId": "ac21b9a1-8853-4658-9fbf-0cf62340bd18", {
            "divisionNameid": null"0f106af0-a919-44c5-b211-15bd5ef620b6",
            "revisionsname": []
        },
        {"ID_BuildingModel",
            "iddivisionId": "30114b52b539790e-bc052ffc-47c143cd-80b59582-c7d5485d5840b4aa27b36693",
            "namedivisionName": "ID_FinishModelModel1",
            "divisionIddivisionTopologyId": "ac21b9a125f38274-88537158-4658436d-9fbf9356-0cf62340bd18f5c917ee44c9",
            "divisionNamerevisions": null,[
               "revisions": []
 1
            }],
             {"visible": false,
            "idopaque": "09e623d4-1e12-4a77-b358-ea1d0b28e4a7"false,
            "nameopacity": "ID_RoomModel",
0
        },
       "divisionId": "ac21b9a1-8853-4658-9fbf-0cf62340bd18", {
            "divisionNameid": null"30114b52-bc05-47c1-80b5-c7d5485d5840",
            "revisionsname": []
    "ID_FinishModel",
    }
    ],
    "rightsdivisionId": {"b539790e-2ffc-43cd-9582-b4aa27b36693",
            "projectAdmindivisionName": false"Model1",
            "projectDeletedivisionTopologyId": false"25f38274-7158-436d-9356-f5c917ee44c9",
            "projectEditrevisions": false,[
            "modelsCreate": false,
   1
         "modelsViewAll   ],
            "visible": false,
            "opaque": false,
            "opacity": true0
        },
        {
            "id": "586b02be09e623d4-43b81e12-4e274a77-b698b358-e067e85e38e2ea1d0b28e4a7"
}

...

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

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

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,

...

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

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",
            "phone1projectId": "089/12793-11150d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
        "name": "Geometry information missing for wall",
        "phone2description": "0171/71384483",
            "emailThe geometry information is missing for the wall in the kitchen",
        "author": "MyName@NemetschekMr.com Architect",
                 "citystatus": "Munichopen",
                 "zipcreatedAt": "818292013-06-02T10:05:00+00:00",
                 "streetdueDate": "Konrad2013-Zuse-Platz1"
        },
        "Customer": {
            "name": "Bimplus customer",
            "phone1": "001-201-1279345",
            "email": "MyName@Nemetschek.com",
            "city": "New Jersy",
            "zip": "08201"
        }
    }
}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

	createIssueInProjectcreateAttachmentcreateIssueInProject
	createAttachment

Create

...

a new attachment in the project

Deck of Cards

id	bimCreateIssuebimCreateAttachmentInProject

Card

default	true
label	URL / Resource / JSON Structure

Resource: projectsprojects/<project_id>issuesid>/attachments

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

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

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.

responsible (date) issue

Name	Mandatory / Optional	Type	Description
objectIds
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	The id of the objects to which the file has to be attached
fileNameauthor	optional	objectstring	Author of the issue	Name of the file to be attached to the project
type		optional	object	Responsible person for the issue	string	Mime type
sizeInMBstatus	optional	stringinteger	Status Size of the issue. Should have one of the values: Open, Solved or Closedfile to be attached to the project
createdAt	will be ignored	string		Creation date of the	attachment
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.

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)

Card

label	HTTP Method

POST

Card

label	Description

Creates a new attachment in a project.

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

Code Block

borderColor	Green
title	Headers
lang	xml

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

Image Added

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 201 Created

Code Block

borderColor	Red
title	JSON
lang	xml

   {
         "shortIdobjectIds": 1
[
           "projectId": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
        ],
        "namefileName": "Fire Exit WrongBuilding_Plan.jpg",
    "description": "The fire exit is in the wrong place"type": "image/jpeg",
     "author" : { "idsize" : "92fa66c6-4114-d68e-974c-0ff78a49fda8" }211258,
     "responsible" : { "idcreatedAt" : "11fa66c62013-4114-d68e-974c-0ff78a49fda8" },  
12-11T10:47:39",
        "statuscreator": "open",
{
        "createdAtid": "2013-06-02T10:05:00+00:00e18941f4-a809-2d01-d27d-cd251f2b6cb6",
        "dueDateemail": "2013-06-05T10:05:00+00:00test@bimplus.net",
    "solution": null,
    "classificationfirstname": "First Name",
        "prioritylastname": "verySecond highName",
        "revisioncompany": null"Best-Company",
       "id": "8ead8bfe-ab23-4340-ac47-38181e83bff3"
}

...

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,
fullname": "First Name Second Name",
        "displayname": "Best-Company",
        "info": "",
        "gender": "",
        "phoneWork": "",
        "phoneHome": "",
        "fax": "",
        "mobile": "",
        "birthDate": "0000-00-00",
        "address": {
            "street": "Westermeier str.",
            "projectIdstreetNr": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e10",
        "name            "zip": "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,
       "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. 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)

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": "8ead8bfe-ab23-4340-ac47-38181e83bff3"
    },
    {
        "shortId": 2,
        "projectIdobjectIds": "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[
            "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
        ],
        "fileName": "Building_Plan.jpg",
        "type": "image/jpeg",
        "size": 211258,
        "createdAt": "2013-0612-05T1011T10:05:00+00:0047:39",
            "solutioncreator": null,
        "classification{
        "id": "e18941f4-a809-2d01-d27d-cd251f2b6cb6",
            "priorityemail": "hightest@bimplus.net",
        "revision": null,
        "idfirstname": "a171bc90-b03f-4ddd-9794-cf77f424f4e2"
    }
]

...

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

...

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

...

Create a new attachment in the project

Deck of Cards

id	bimCreateAttachmentInProject

User defined classification (We will change this to a list later)

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

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

Card

label	HTTP Method

POST DELETE

Card

label	Description

Creates a new attachment in a 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: multipartapplication/form-datajson

Image Removed

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 201200 Created
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": [

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",
{
            "displaynameparent": "Best-Company0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
            "infoname": ""null,
            "gendertype": "ID_TopologyDivision",
        "phoneWork": "",
        "phoneHomechildren": ""[],
            "faxid": "",195db084-3715-4ebc-b164-3ee47a495b2e"
        "mobile": "",}
    ],
    "birthDateid": "0000-00-00",
        "address": {
            "street": "Westermeier str.",
            "streetNr": "10",
            "zip": "81829",
            "city": "München",
    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

[
    {
        "countryissueId": "Germany"
        }5eac4d92-c65b-49c8-927c-9f255879a5c2",
        "preferedLanguageobjectId": "en"
       }442af981-4175-4f1d-90f0-ef1c8641f0cb",
        "idtopologyNodeId": "6cea110a4be5ffd3-88f41e5e-43ac42a7-9a009844-ebaf677be33323b55fb39253",
        "position": }

...

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

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

    {{
            "x": 78696.44,
            "y": 9652.251,
            "z": 580
        },
        "normalVector": {
            "x": 0,
            "y": 0,
            "z": 1
        },
        "createdAt": "2014-05-09T12:17:18",
        "objectIdsid": [
 "3ba43939-5805-4aac-b7a5-8cf3b5833ac3"
    },
    {
        "issueId": "0d2ce2cc5333bb42-35882cb9-45d64f11-a59aafd8-f6b89ebed34e"
        ]120c79edef37",
        "fileNameobjectId": "Building_Plan.jpgae1a139a-1e13-491f-b6d8-a46f699e295e",
        "typetopologyNodeId": "image/jpeg37a26e8b-566e-4d6e-8ab2-f35a715e83e2",
        "sizeposition": 211258,
{
            "createdAtx": "2013-12-11T10:47:39",
41677.4336,
            "creatory": {
10095.9512,
            "idz": "e18941f4-a809-2d01-d27d-cd251f2b6cb6",-9020
        "email": "test@bimplus.net"},
        "firstnamenormalVector": {
   "First Name",
        "lastnamex": "Second Name"0,
            "companyy": "Best-Company"0,
        "fullname": "First Name Second Name","z": 1
        "displayname": "Best-Company"},
        "infocreatedAt": "2014-05-09T12:17:33",
        "genderid": "",fa9acf26-efdf-4297-80b5-2422bbf6e35a"
    },
    "phoneWork": "",{
        "phoneHomeissueId": "5eac4d92-c65b-49c8-927c-9f255879a5c2",
        "faxobjectId": "effc5f9f-dcae-4e5f-9a67-189d4a285612",
        "mobiletopologyNodeId": "4be5ffd3-1e5e-42a7-9844-23b55fb39253",
        "birthDateposition": "0000-00-00",
{
            "addressx": {-440,
            "streety": "Westermeier str."10767.11,
            "streetNrz": "10",
-8243.917
        },
        "zipnormalVector": "81829",{
            "cityx": "München"-1,
            "countryy": "Germany"
    0,
    },
        "preferedLanguagez": "en"0
        },
        "id": "6cea110a-88f4-43ac-9a00-ebaf677be333"
    }

...

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

...

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": ["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
        {
    },
        "parentcreatedAt": "0d2ce2cc2014-3588-45d6-a59a-f6b89ebed34e05-21T13:34:07",
        "id": "2b693990-a611-4b05-9efd-7485a9aeebbb"
   "name": null},
    {
        "typeissueId": "ID_TopologyDivision5eac4d92-c65b-49c8-927c-9f255879a5c2",
            "children": [],
    "objectId": "83821c97-0020-480e-b863-9981df590c0a",
        "idtopologyNodeId": "195db084aa7e1b6f-37157324-4ebc459b-b164a114-3ee47a495b2e9833806f89ed",
        "position": }{
        ],
    "idx": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
}

...

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

[
    {664.999939,
            "y": 7197.733,
            "z": -58535.82
        },
        "normalVector": {
            "x": -1,
            "y": 0,
            "z": 0
        },
        "issueIdcreatedAt": "5eac4d92-c65b-49c8-927c-9f255879a5c22014-05-27T09:18:17",
        "objectIdid": "442af981f2a9c63f-41752514-4f1d4c1f-90f0be78-ef1c8641f0cb758a984b5430",
        "topologyNodeId": "4be5ffd3-1e5e-42a7-9844-23b55fb39253",
  }
]

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

[
    {
      "position": {
            "x": 78696.44,
            "y": 9652.251,
            "z": 580
        },
        "normalVector": {
            "x": 0,
            "yid": 0,
            "z": 1
        } "0f106af0-a919-44c5-b211-15bd5ef620b6",
        "createdAtname": "2014-05-09T12:17:18ID_BuildingModel",
        "iddivisionId": "3ba43939ac21b9a1-58058853-4aac4658-b7a59fbf-8cf3b5833ac30cf62340bd18",
     },
    {"divisionName": null,
        "issueIdrevisions": "5333bb42-2cb9-4f11-afd8-120c79edef37",[]
    },
    "objectId": "ae1a139a-1e13-491f-b6d8-a46f699e295e",{
        "topologyNodeIdid": "37a26e8b63b069d2-566e81df-4d6e4418-8ab291de-f35a715e83e28a954fa12924",
        "positionname": {
    "ID_DesignModel_Timber",
        "xdivisionId": 41677.4336,
    "ac21b9a1-8853-4658-9fbf-0cf62340bd18",
        "ydivisionName": 10095.9512null,
            "zrevisions": -9020[]
    },
    },{
        "normalVectorid": {
"30114b52-bc05-47c1-80b5-c7d5485d5840",
        "name": "ID_FinishModel",
        "xdivisionId": 0"ac21b9a1-8853-4658-9fbf-0cf62340bd18",
            "ydivisionName": 0null,
            "zrevisions": 1[]
    },
    },{
        "createdAtid": "2014-05-09T12:17:3309e623d4-1e12-4a77-b358-ea1d0b28e4a7",
        "idname": "fa9acf26-efdf-4297-80b5-2422bbf6e35a"
    },
    {ID_RoomModel",
        "issueIddivisionId": "5eac4d92ac21b9a1-c65b8853-49c84658-927c9fbf-9f255879a5c20cf62340bd18",
        "objectIddivisionName": null,
        "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":"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

[
    {
 {
            "xname": 0"TestStructure",
            "ydescription": 0"FullLifeCycleTest",
            "ztype": 1"CostStructure",
        "nr": }1,
        "createdAtcolor": "2014-05-21T13:34:07"0,
        "id": "2b693990179439d6-a611df16-4b0541cc-9efdbd2c-7485a9aeebbb74d05b7995d5"
    },
    {
        "issueIdname": "5eac4d92-c65b-49c8-927c-9f255879a5c2",
        "objectId": "83821c97-0020-480e-b863-9981df590c0a",
        "topologyNodeId": "aa7e1b6f-7324-459b-a114-9833806f89edTestStructure2",
        "positiondescription": {
     "Another Structure",
        "xtype": 664.999939"SpecificationStructure",
            "ynr": 7197.7332,
            "zcolor": -58535.82
0,
         },"id": "279439d6-df16-41cc-bd2c-74d05b7995d5"
        "normalVector": {
            "x": -1,
            "y": 0,
            "z": 0
        },
        "createdAt": "2014-05-27T09:18:17",
        "id": "f2a9c63f-2514-4c1f-be78-758a984b5430"
    }
]

...

}
]

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

...

Get the project disciplines

Deck of Cards

id	bimGetProjectDisc

Card

default	true
label	URL / Resource / JSON Structure

Resource: projectsstructures/<project_id>/disciplines topology

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

Example: https://api-stage.bimplus.net/v2/bimplus/projectsstructures/586b02bedb540336-43b847a3-4e27426e-b698b3bf-e067e85e38e21e532bfac8ea>/disciplinestopology

Card

label	HTTP Method

GET

Card

label	Description

Get the layers 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

[
    {
        "idparent": "0f106af0-a919-44c5-b211-15bd5ef620b6"null,
        "name": "ID_BuildingModelTest for Structure",
        "divisionIdtype": "ac21b9a1-8853-4658-9fbf-0cf62340bd18ID_Project",
        "divisionNamechildren": null,[
        "revisions": []
    },{
    {
        "idparent": "63b069d2622272da-81dff1ff-441845ab-91dea3f0-8a954fa12924c8f1255c80e8",
            "name": "ID_DesignModel_TimberTestStructure",
            "divisionIdtype": "ac21b9a1-8853-4658-9fbf-0cf62340bd18Structure",
            "divisionNamechildren": null,
[
               "revisions": []
 {
        },
    {
        "idparent": "30114b52179439d6-bc05df16-47c141cc-80b5bd2c-c7d5485d584074d05b7995d5",
           "name": "ID_FinishModel",
        "divisionIdname": "ac21b9a1-8853-4658-9fbf-0cf62340bd18Node 1",
           "divisionName": null,
        "revisionstype": []
"Structure",
        },
    {
        "idchildren": "09e623d4-1e12-4a77-b358-ea1d0b28e4a7",[
        "name": "ID_RoomModel",
        "divisionId": "ac21b9a1-8853-4658-9fbf-0cf62340bd18",
      {
  "divisionName": null,
        "revisions": []
    }
]

...

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 Removed

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

...

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

...

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

[
    {
                "parent": "adf506ae-3628-4501-9af1-22bcf27e4ab4",
                            "name": "WallConnection",
                            "type": "StructureElement",
                            "children": [
                                {
                                    "parent": "35b986c2-e9cd-482e-9281-6000671a49f0",
                                    "name": "Wall-005",
                                    "type": "ID_ArchWall",
                                    "children": [],
                                    "nameid": "TestStructure",
df4a81d6-42fb-4187-bbce-82a2fc093b2f"
                               "description": "FullLifeCycleTest",
 }
         "type": "CostStructure",
        "nr": 1,
        "color": 0],
           "id": "179439d6-df16-41cc-bd2c-74d05b7995d5"
    },
    {
        "nameid": "TestStructure2",
35b986c2-e9cd-482e-9281-6000671a49f0"
             "description": "Another Structure",
        "type": "SpecificationStructure",
 }
          "nr": 2,
        "color": 0],
               "id": "279439d6-df16-41cc-bd2c-74d05b7995d5"
    }
]

...

"id": "adf506ae-3628-4501-9af1-22bcf27e4ab4"
                }
            ],
            "id": "179439d6-df16-41cc-bd2c-74d05b7995d5"
        }
    ],
    "id": "622272da-f1ff-45ab-a3f0-c8f1255c80e8"
}

Anchor

	getAllComments
	getAllComments

Get all the comments, hyperlinks from the project

Deck of Cards

id	bimGetAllComments

Card

default	true
label	URL / Resource / JSON Structure

Resource: comments, hyperlinks

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

...

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

...

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>/structuresprojects/<project_id>/topologyhyperlinks

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

Card

label	HTTP Method

GET

Card

label	Description

Get the topology of all structures belonging to a specified Get all the comments, hyperlinks 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

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

	getAllCommentsdeleteProject	getAllComments

...

	deleteProject

Delete

...

the project

Deck of Cards

id	bimGetAllCommentsbimDeleteProject

Card

default	true
label	URL / Resource / JSON Structure		URL / Resource / JSON Structure

Resource: projects/<project_id>

URL:

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/db5403360d2ce2cc-47a33588-426e45d6-b3bf-1e532bfac8ea>/comments OR https://api-stage.bimplus.net/v2/bimplus/projects/db540336-47a3-426e-b3bf-1e532bfac8ea>/hyperlinksa59a-f6b89ebed34e

Card

label	HTTP Method

GET DELETE

Card

label	Description

Get all the comments, hyperlinks from the project 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

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

...

Delete the project

...

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.

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

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

...

label	Response

...

borderColor	Green
title	Status
lang	xml

...

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 16

New Version 17

Key

Update the project

Create an issue in the project

Get the Issue List from the project

Update the project

Delete all the issues from the project

Create

a new attachment in the project

Get the Issue List from the project

Get the Attachment List from the project

Delete all the attachments from the project

Delete all the issues from the project

Create a new attachment in the project

Get the project topology tree

Get the spot list from 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 the project disciplines

Create / Upload a thumbnail to the project

Download the thumbnail

Get the structure list from a project

Get all the comments, hyperlinks from the project

Delete all the structures from a project

Get the topology of all structures belonging to a project

Delete

the project

Delete the project