Page History

Project Service

...

Anchor

	projectService
	projectService

Project Service

...

A Project is basically a holder which contains building models.

...

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

Card

label	HTTP Method

POST

Card

default	true
label	Description

Creates a new project.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Code Block

borderColor	Red
lang	xml
title	JSON

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

borderColor	Red
lang	xml
title	JSON

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

Anchor

	getCurrentProjectListcreateCopyProjectFromSourceProjectgetCurrentProjectList
	createCopyProjectFromSourceProject

...

Create copy of the source project

Deck of Cards

id	bimGetCurrentProjectListbimCreateCopyProjectFromSourceProject

default

Card

true	label	URL Url / Resource / JSON StructureJson

Resource:

projects

projects/copyfrom

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

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

Card

label	HTTP Method

GET

Card

label	Description

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

/copyfrom

JSON Structure:

Name	Mandatory / Optional	Type	Description
id	mandatory	string(guid)	Source project Id. Only projects from 'Bimplus Demo' team are supported by this api function.
name	mandatory	string	Unique name of the newly created project.
shortDescr	optional	string	Description of the newly created project.

Card

label	HttpMethod

POST

Card

label	Description

Creates new project as copy of the source project. The content of source project from "Bimplus Demo" team will be copied to user team.

Card

label

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[
    {
        "id": "586b02be1eb8efe0-43b87611-4e2747e7-b698a06d-e067e85e38e2102ec8e2fff6",
        "name": "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"Copy of the Mallorca V1",
        "shortDescr": "Hey, i am your favourite test "Description of the new copy of the Mallorca V1"
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

borderColor	Red
lang	xml
title	JSON

{
entry",
        "thumbnailtopicCount": ""0,
    "attachmentCount": 2,
    "createdprojectAttachmentCount": "2013-05-01T09:33:18"0,
        "createdbyname" : {
 "Copy of the    Mallorca V1",
     "idshortDescr" : "f4b1178d-385f-449c-a2a7-6f58b264d90c"
        Description of the new copy of the Mallorca V1",
    "emailhasWriteAccess" : "owner@company1.com"false,
        }"teamSlug": null,
    "thumbnail": null,
    "changedcreated": "20132014-0502-01T0913T12:3339:1836",
        "changedbycreatedby" : {
            "id" : "f4b1178de0837206-385f4bff-449c65d4-a2a7b79f-6f58b264d90cf3878c3567fd",
            "email" : "owner@company1demo@bimplus.comnet",
         }"firstname": "bim+",
        "addresslastname" : "Addressa ofservice companyby 1Allplan"
    },
    "hasWriteAccesschanged": false"2019-01-24T11:51:40.55",
        "teamSlug": "company1","changedby": {
        "modelCountid" : 3"e0837206-4bff-65d4-b79f-f3878c3567fd",
        "memberCountemail" : 3"demo@bimplus.net",
        "sizefirstname" : 63488"bim+",
        "sizeMBlastname" : "0.06",a service by Allplan"
    },
    "rightsmodelCount": {2,
            "projectAdmin"memberCount": false1,
            "projectDeletesize": false32839680,
            "projectEdit"attachmentsSize": false0,
            "modelsCreate"sizeMB": false"31.32",
            "modelsViewAllapprovalProcess": false0,
    "id": "990d0772-8b87-479a-9ed6-b0b46a204301"
}

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 entire list of projects in which the logged in user is a member

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[
    {    }
    },
    {
        "id": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
        "name": "Your Awesome Building",
        "shortDescr": "Example for creating a project",
        "thumbnailid": "586b02be-43b8-4e27-b698-e067e85e38e2",
        "createdname": "0001-01-01T00:00:00!!!!!_VORTEILSHAUS V40 SD45 Traufeingang",
        "createdbyshortDescr" : {
"Hey, i am your favourite        "id": "7c555899-5a5f-44d1-930e-284930678bed"test entry",
            "emailthumbnail" : "testuser@bimplus.net"
        },
        "changedcreated": "00012013-0105-01T0001T09:0033:0018",
        "changedbycreatedby" :  {
            "id" : "7c555899f4b1178d-5a5f385f-44d1449c-930ea2a7-284930678bed6f58b264d90c",
            "email" : "testuser@bimplusowner@company1.netcom",
        },
        "addresschanged" : "My address somewhere2013-05-01T09:33:18",
        "changedby" : {
            "id" : "f4b1178d-385f-449c-a2a7-6f58b264d90c"
            "email" : "owner@company1.com",
        },
        "address" : "Address of company 1"
        "hasWriteAccess": truefalse,
        "teamSlug": "best-companycompany1",
        "modelCount" : 43,
        "memberCount" : 23,
        "size" : 426393663488,
        "sizeMB" : "4,070.06",
        "rights": {
            "projectAdmin": truefalse,
            "projectDelete": truefalse,
            "projectEdit": truefalse,
            "modelsCreate": truefalse,
            "modelsViewAll": truefalse
        }
    },
]

...

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
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[
    {
        "id": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"    {
        "id": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
        "name": "Your Awesome Building",
        "shortDescr": "Example for creating a project",
        "thumbnail": "",
        "name": "Your Awesome Building",
        "shortDescr": "Example for creating a project",
        "thumbnail": "",
        "created": "0001-01-01T00:00:00",
        "createdby" : {
            "id": "7c555899-5a5f-44d1-930e-284930678bed",
            "email" : "testuser@bimplus.net"
        },
        "changed": "0001-01-01T00:00:00",
        "changedby" : {
            "id": "7c555899-5a5f-44d1-930e-284930678bed",
            "email" : "testuser@bimplus.net"
        },
        "address" : "My address somewhere",
        "hasWriteAccess": true,
        "teamSlug": "best-company",
        "modelCount": 4,
        "memberCount": 2,
        "size" : 4263936,
        "sizeMB" : "4,07",
        "rights": {
            "projectAdmin": true,
            "projectDelete": true,
            "projectEdit": true,
            "modelsCreate": true,
            "modelsViewAll": true
        }
    },
]

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
lang	xml
title	Headers

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

This call also supports filtering and paging

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[
    {
    {
        "id": "4e87944a-a477-4e4c-862e-e723dcb43066",
        "name": "UC_Fly-over Kerensheide",
        "shortDescr": "",
        "thumbnail": "",
        "created": "2013-05-10T07:13:38",
        "createdby" : {
            "id": "bda91f090d2ce2cc-2cc63588-45da45d6-bba0a59a-5f92828f58bcf6b89ebed34e",
        "name": "Your Awesome Building",
  "email" : "UserA@bimplus.net"      "shortDescr": "Example for creating a project",
        }"thumbnail": "",
        "changedcreated": "20130001-0501-16T0701T00:3400:5600",
        "changedbycreatedby" : {
            "id": "7c555899-5a5f-44d1-930e-284930678bed",
            "email" : "testuser@bimplus.net"
        },
        "addresschanged" : "0001-01-01T00:00:00",
        "hasWriteAccesschangedby" : true,
{
            "teamSlugid": "best-company7c555899-5a5f-44d1-930e-284930678bed",
            "modelCountemail" : 2,"testuser@bimplus.net"
        "memberCount": 3},
        "sizeaddress" : 63488"My address somewhere",
        "sizeMBhasWriteAccess": "0,06"true,
        "teamSlug": "best-company",
        "modelCount": 4,
        "memberCount": 2,
        "size" : 4263936,
        "sizeMB" : "4,07",
        "rights": {
            "projectAdmin": falsetrue,
            "projectDelete": falsetrue,
            "projectEdit": true,
            "modelsCreate": falsetrue,
            "modelsViewAll": true
        }
    },
]

...

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
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

{  
	"name" : "Your Awesome Building",
	"shortDescr" : "Example for creating a project"    
	"teamName": "jay-company",
    "teamSlug": "jay-company",
    "hasWriteAccess": true,
    "thumbnail": "/jay-company/projects/de87fc4d-cb5d-44ba-b2ea-1d96ac564a8a/thumbnail/download",
    "created": "2014-02-14T09:48:27",
    "createdby"    {
        "id": "4e87944a-a477-4e4c-862e-e723dcb43066",
        "name": "UC_Fly-over Kerensheide",
        "shortDescr": "",
        "thumbnail": "",
        "created": "2013-05-10T07:13:38",
        "createdby" : {
            "id": "bda91f09-2cc6-45da-bba0-5f92828f58bc",
            "email" : "UserA@bimplus.net"
        },
        "changed": "2013-05-16T07:34:56",
        "changedby" : {
            "id": "71e0ac3b7c555899-fa495a5f-e54044d1-ac2f930e-8caff3dd72ed284930678bed",
            "email" : "jayarajtestuser@bimplus.purushothaman@gmail.comnet"
        },
      "changed":  "2015-11-19T09:45:51",
    "changedby": {address" : ""
        "idhasWriteAccess": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed"true,
        "emailteamSlug": "jayaraj.purushothaman@gmail.com"best-company",
    },
    "addressmodelCount": ""2,
    "modelCount": 1,
    "memberCount": 73,
    "topicCount": 30,
    "attachmentCountsize": 1363488,
    "size": 99317760,
    "sizeMB": "940,7206",
        "disciplinesrights": [{
             {"projectAdmin": false,
            "idprojectDelete": "0f106af0-a919-44c5-b211-15bd5ef620b6"false,
            "nameprojectEdit": "ID_BuildingModel"true,
            "divisionIdmodelsCreate": "b539790e-2ffc-43cd-9582-b4aa27b36693",false,
            "divisionNamemodelsViewAll": "Model1",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

Optional query parameters

Name

Type

Default value

Description

disciplines

string (bool)

true

When query parameter "disciplines=false" is defined, the API will return project properties except "disciplines" project property.
e.g. https://api-stage.bimplus.net/v2/bimplus/projects/586b02be-43b8-4e27-b698-e067e85e38e2?disciplines=false
This api call is faster variant when client does not use returned discipline project property .

Otherwise if query parameter "disciplines" is true (this is default) or is missing the call will return all project properties.
e.g. https://api-stage.bimplus.net/v2/bimplus/projects/586b02be-43b8-4e27-b698-e067e85e38e2?disciplines=true

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
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

{  
	"name" : "Your Awesome Building",
	"shortDescr" : "Example for creating a project"    
	"teamName": "jay-company",
    "teamSlug": "jay-company",
    "hasWriteAccess": true,
    "thumbnail": "/jay-company/projects/de87fc4d-cb5d-44ba-b2ea-1d96ac564a8a/thumbnail/download",
    "created": "2014-02-14T09:48:27",
    "createdby": {"divisionTopologyId": "25f38274-7158-436d-9356-f5c917ee44c9",
            "revisions": [
                1
            ],
            "visible": false,
            "opaque": false,
            "opacity": 0
        },
        {
            "id": "30114b52-bc05-47c1-80b5-c7d5485d5840",
            "name": "ID_FinishModel",
            "divisionId": "b539790e-2ffc-43cd-9582-b4aa27b36693",
            "divisionName": "Model1",
            "divisionTopologyId": "25f38274-7158-436d-9356-f5c917ee44c9",
            "revisions": [
                1,2"id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
        "email": "jayaraj.purushothaman@gmail.com"
    ]},
    "changed": "2015-11-19T09:45:51",
       "visiblechangedby": false,{
            "opaqueid": false"71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "opacityemail": 0"jayaraj.purushothaman@gmail.com"
    },
    }"address": "",
    "modelCount": 1,
   {
 "memberCount": 7,
    "topicCount": 30,
     "idattachmentCount": "09e623d4-1e12-4a77-b358-ea1d0b28e4a7"13,
        "size": 99317760,
    "namesizeMB": "ID_RoomModel94,72",
    "disciplines": [
       "divisionId": " {
            "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
        },
    ],
    "rights": {
            "projectAdminid": true"30114b52-bc05-47c1-80b5-c7d5485d5840",
            "projectDeletename": true"ID_FinishModel",
            "projectEditdivisionId": true"b539790e-2ffc-43cd-9582-b4aa27b36693",
            "modelsCreatedivisionName": true,
"Model1",
             "modelsViewAll": true
"divisionTopologyId": "25f38274-7158-436d-9356-f5c917ee44c9",
            "revisions": [
                1,2
          }  ],
    "id": "5cd37c77-d341-4ab2-9f0d-44467955b218"
}

...

        "visible": false,
            "opaque": false,
            "opacity": 0
        },
        {
            "id": "09e623d4-1e12-4a77-b358-ea1d0b28e4a7",
            "name": "ID_RoomModel",
            "divisionId": "b539790e-2ffc-43cd-9582-b4aa27b36693",
            "divisionName": "Model1",
            "divisionTopologyId": "25f38274-7158-436d-9356-f5c917ee44c9",
            "revisions": [
                1
            ],
            "visible": false,
            "opaque": false,
            "opacity": 0
        }
    ],
    "rights": {
        "projectAdmin": true,
        "projectDelete": true,
        "projectEdit": true,
        "modelsCreate": true,
        "modelsViewAll": true
    },
    "id": "5cd37c77-d341-4ab2-9f0d-44467955b218"
}

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 properties of the specified project.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Code Block

borderColor	Red
lang	xml
title	JSON

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

title	JSON

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

Anchor

	createIssueInProject
	createIssueInProject

Create an issue in the project with a view

See Create Issue in Topic Service

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

Optional query parameters

Name	Type	Default value	Description
shortinfo	boolean	false	When query parameter "shortinfo=true" is defined, the API function returns only classes of all tasks metric.

Card

label	HTTP Method

GET

Card

label	Description

Get list of issues of given project.

Response depends on the user rights :

for project admin or account owner - returns all existing issues in the project
for project editor or viewer - returns only issues where the user is author or responsible ( although still exist the possibility to get all the issues, by using query parameter "?showAll=true" )

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

This call also supports filtering and paging

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[
 {
  "name": "Wall info wrong",
  "author": {
    "id": "7c555899-5a5f-44d1-930e-284930678bed",
    "email": "testuser1@allplan.com",
    "firstname": "Test",
    "lastname": "User1",
    "company": "Allplan Bratislava",
    "fullname": "Test User1"
  },
  "responsible": {
    "id": "0132ecbe-2ac5-4ae1-945d-d38fc3bc1e82",
    "email": "testuser1@allplan.com",
    "firstname": "Test",
    "lastname": "User2",
    "company": "Allplan Bratislava",
    "fullname": "Test User2"
  },
  "scene": null,
  "attachmentsCount": 0,
  "pinsCount": 0,
  "commentsCount": 0,
  "hyperlinksCount": 0,
  "shortId": 4,
  "projectId": "de87fc4d-cb5d-44ba-b2ea-1d96ac564a8a",
  "description": "This wall is wrong",
  "status": "Open",
  "createdAt": "2016-02-15T08:12:49.9831726+01:00",
  "modifiedAt": "2016-02-15T08:12:49.9831726+01:00",
  "dueDate": null,
  "solution": "MySolution",
  "type": "Problem",
  "classification": "Problems",
  "priority": "High",
  "cc": [
    "abc@bimplus.net"
  ],
  "id": "01b5768a-bd19-4049-b72e-b44485514ef8"
 },
 ...
]

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
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

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

Card

label	HTTP Method

POST

Card

label	Description

Creates a new attachment in a project.

Card

label	Request

Bimplus supports creating and updating of attachments using requests with multipart/form-data content type. By standard, multipart/form-data content consists of several parts, each part containing a file data.

But Bimplus supports only one file sent per call, so only first part of multipart form data content is used, the rest are ignored. The parts are separated by boundaries, each part contains content headers and content data.

Examples :

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: multipart/form-data; boundary=----MyFormBoundarytlTJWL8i2mvYwGPW

Code Block

title	Content

------MyFormBoundarytlTJWL8i2mvYwGPW
Content-Disposition: form-data; name="TestFile"; filename="TestFile.xml"; classification="Report"; tag="ABCDE"
Content-Type: application/xml
 
**** Here are file data  ******
 
------MyFormBoundarytlTJWL8i2mvYwGPW

Where :

name and filename are mandatory saved as attachment's "name" and "filename" properties
classification and tag are optional, and are saved as attachment's properties "tag" and "classification"
Content-Type is mandatory and is saved as attachment's property "type"

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

borderColor	Red
lang	xml
title	JSON

{

     "objectIds": [
         "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
     ],
     "fileName": "TestFile.xml",
     "type": "application/xml",
     "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",
     },
     "changed" : "2013-12-11T10:47:39",
     "changedBy" : {
         "id": "e18941f4-a809-2d01-d27d-cd251f2b6cb6",
         "email": "test@bimplus.net",
     },
     "hash": "68a59c1f-1914-43b8-92fc-1cee4ad1c90c",
     "attachmentType" : "Document",
     "classification" : "Report",
     "tag" : "ABCDE",
     "sizeMB" : "0,21",
     "version" : "1",
     "relatedId" : "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
     "rights" : {
         "update" : true,
         "share" : true,
         "delete" : true,
         "download" : true
     },
     "id": "6cea110a-88f4-43ac-9a00-ebaf677be333"
}

Anchor

	createChunkedAttachment
	createChunkedAttachment

Create a new attachment in the project using chunked upload

Deck of Cards

id	bimCreateChunkedAttachmentInProject

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects/<project_id>/attachments/chunked

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

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

Card

label	HTTP Method

PUT

Card

label	Description

Creates a new attachment in a project. The upload can be performed in chunks that allow it to exceed the 2GB file limit. After uploading the 1st chunk the file gets locked until finishing upload of the last chunk based on the 'Content-Range' header.

Card

label	Request

Bimplus supports creating and updating attachments in chunks.

After the upload of the first chunk, the response contains a file ID, that should be passed as 'Chunk-FileId' header in upcoming requests.

Examples :

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Range: bytes 0-20971520/22471573
Chunk-FileId: 6cea110a-88f4-43ac-9a00-ebaf677be333 
Content-Disposition: inline; name="Document"; filename="file.pdf"

Where :

name and filename are mandatory saved as Content-Disposition "name" and "filename" properties
classification and tag are optional, and are saved as attachment's properties "tag" and "classification"
Content-Type is mandatory and is saved as attachment's property "type"

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

borderColor	Red
lang	xml
title	JSON

{

     "objectIds": [
         "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
     ],
     "fileName": "TestFile.xml",
     "type": "application/xml",
     "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",
     },
     "changed" : "2013-12-11T10:47:39",
     "changedBy" : {
         "id": "e18941f4-a809-2d01-d27d-cd251f2b6cb6",
         "email": "test@bimplus.net",
     },
     "hash": "68a59c1f-1914-43b8-92fc-1cee4ad1c90c",
     "attachmentType" : "Document",
     "classification" : "Report",
     "tag" : "ABCDE",
     "sizeMB" : "0,21",
     "version" : "1",
     "relatedId" : "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
     "rights" : {
         "update" : true,
         "share" : true,
         "delete" : true,
         "download" : true
     },
     "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)

This call also supports filtering and paging

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[    
   {

     "objectIds": [
         "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
     ],
     "fileName": "TestFile.xml",
     "type": "application/xml",
     "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",
     },
     "changed" : "2013-12-11T10:47:39",
     "changedBy" : {
         "id": "e18941f4-a809-2d01-d27d-cd251f2b6cb6",
         "email": "test@bimplus.net",
     },
     "hash": "68a59c1f-1914-43b8-92fc-1cee4ad1c90c",
     "attachmentType" : "Document",
     "classification" : "Report",
     "tag" : "ABCDE",
     "sizeMB" : "0,21",
     "version" : "1",
     "relatedId" : "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
     "rights" : {
         "update" : true,
         "share" : true,
         "delete" : true,
         "download" : true
     },
     "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
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

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

...

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 properties of the specified project.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Code Block

borderColor	Red
lang	xml
title	JSON

{
    "name" : "Your Awesome Building updated",
	"shortDescr" : "Example for updating a project",
    "address": "Changed address",
}
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

{
    "nameparent" : "Your Awesome Building updated"null,
	"shortDescr" : "Example for updating a project",
    "teamName": "Best Company""name": My Project,
    "teamSlugtype": "best-companyProject",
    "hasWriteAccesschildren" : true,
    "thumbnail": null,
    "created": "2013-06-01T10:05:00",
    "createdby" : {: [
        "id": "7c555899-5a5f-44d1-930e-284930678bed",
  {
            "emailifcId" : "testuser@bimplus.net1o1vYcpcH5KRRKl5voLOXN",
    },
        "changedifcType": "2013-06-02T10:04:15IfcBuilding",
    "changedby" : {
        "idparent": "7c5558990d2ce2cc-5a5f3588-44d145d6-930ea59a-284930678bedf6b89ebed34e",
            "emailname" : "testuser@bimplus.net"null,
    },
        "addresstype" : "Changed addressID_TopologyDivision",
    "modelCount": 0,
        "memberCountchildren": 1[],
     "topicCount": 0,
       "attachmentCountid": 0,"195db084-3715-4ebc-b164-3ee47a495b2e"
    "size": 0,    }
    "sizeMB": "0"],
    "id": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
}

Anchor

	createIssueInProjectgetSpotListFromProject	createIssueInProject

Create an issue in the project with a view

See Create Issue in Topic Service

...

	getSpotListFromProject

Get the spot list

...

from the project

Deck of Cards

id	bimGetIssueListFromProjectbimGetSpotListFromProject

Card

default	true
label	URL / Resource / JSON Structure

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

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

Example: https://api-stage.bimplus.net/v2/bimplus/projects/0d2ce2cc586b02be-358843b8-45d64e27-a59ab698-f6b89ebed34ee067e85e38e2/issuespins

Card

label	HTTP Method

GET

Card

label	Description

Get all the issues assigned to a specified project.the spot list from the project

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[
    {
        "issueId": "5eac4d92-c65b-49c8-927c-9f255879a5c2",
        "objectId": "442af981-4175-4f1d-90f0-ef1c8641f0cb",
        "topologyNodeId": "4be5ffd3-1e5e-42a7-9844-23b55fb39253",
        "position": {
            "x": 78696.44,
            "y": 9652.251,
            "z": 580
        },
        "normalVector": {
 [
    {
        "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,
           "projectIdx": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"0,
        "name": "Geometry information missing for wall",
        "descriptiony": "The geometry information is missing for the wall in the kitchen",
        "author": "Mr. Architect",
        "status": "open",
        0,
            "z": 1
        },
        "createdAt": "20132014-0605-02T1009T12:05:00+00:0017:18",
            "dueDateid": "2013-06-05T10:05:00+00:00",
        "solution": null,
        "classification": "",
        "priority": "high",
        "revision": null,
        "id": "a171bc90-b03f-4ddd-9794-cf77f424f4e2"
    }
]

...

Delete all the issues from the project

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
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

...

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

Card

label	HTTP Method

POST

Card

label	Description

Creates a new attachment in a project.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Image Removed

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

borderColor	Red
lang	xml
title	JSON

   {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",
        "objectIdsid": ["a014fcf3-c72e-4def-bc41-58b349b31591"
    },
    {
        "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e""issueId": "5333bb42-2cb9-4f11-afd8-120c79edef37",
        ]"objectId": "367af808-de74-41b4-a3fb-1bfb50559da3",
        "fileNametopologyNodeId": "Building_Plan.jpg9fc99e93-2f33-4247-b3a4-2a6658a9b750",
        "typeposition": "image/jpeg",
{
            "sizex": 21125822525.0254,
            "createdAty": "2013-12-11T10:47:39"10334.1377,
            "creatorz": {-9172
        "id": "e18941f4-a809-2d01-d27d-cd251f2b6cb6"},
        "emailnormalVector": "test@bimplus.net",{
            "firstnamex": "First Name"0,
            "lastnamey": "Second Name"0,
            "companyz": "Best-Company",1
        "fullname": "First Name Second Name"},
        "displaynamecreatedAt": "Best-Company2014-05-21T13:34:07",
        "info": "",id": "2b693990-a611-4b05-9efd-7485a9aeebbb"
    },
    "gender": "",{
        "phoneWorkissueId": "5eac4d92-c65b-49c8-927c-9f255879a5c2",
        "phoneHomeobjectId": "83821c97-0020-480e-b863-9981df590c0a",
        "faxtopologyNodeId": "aa7e1b6f-7324-459b-a114-9833806f89ed",
        "mobileposition": "",{
            "birthDatex": "0000-00-00"664.999939,
            "addressy": {7197.733,
            "streetz": "Westermeier str.",-58535.82
        },
        "streetNrnormalVector": "10",{
            "zipx": "81829"-1,
            "cityy": "München"0,
            "countryz": "Germany"0
        },
        "preferedLanguagecreatedAt": "en"
       }2014-05-27T09:18:17",
        "id": "6cea110af2a9c63f-88f42514-43ac4c1f-9a00be78-ebaf677be333758a984b5430"
    }
]

Anchor

	getAttachmentsgetProjectDisciplinesgetAttachments
	getProjectDisciplines

Get the

...

project disciplines

Deck of Cards

id	bimGetAttachmentListFromProjectbimGetProjectDisc

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

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

URL / Resource / JSON Structure

Resource:

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 disciplines

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

attachments?projectOnly=true)

Card

label	Request

disciplines

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

Code Block

borderColor	Green
lang	xml
title	Headers

Card

label	ResponseHTTP Method

code GETborderColor

GreenStatus: 200 OK

Card

label

lang

xml

title

Status

Description

Get the layers of a project.

Card

label	Request

Code Block

borderColor	RedGreen
lang	xml
title	JSON
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[
    {    {
        "objectIds": [
            "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
        ],
        "fileName": "Building_Plan.jpg",
        "type": "image/jpeg",
        "size": 211258,
        "createdAtid": "2013-12-11T10:47:390f106af0-a919-44c5-b211-15bd5ef620b6",
        "creatorname": {"ID_BuildingModel",
        "iddivisionId": "e18941f4ac21b9a1-a8098853-2d014658-d27d-cd251f2b6cb6",
        "email": "test@bimplus.net9fbf-0cf62340bd18",
        "firstnamedivisionName": "FirstModel Name1",
        "lastnamedivisionTopologyId": "Second Name60c8362a-eb91-412d-ac67-c5d787bf36cb",
        "companyrevisions": "Best-Company",[
        "fullname": "First Name Second Name",1
        "displayname": "Best-Company"],
        "infovisible": ""false,
        "genderopaque": ""false,
        "phoneWorkopacity": "",0
    },
    "phoneHome": "",{
        "faxid": "63b069d2-81df-4418-91de-8a954fa12924",
        "mobilename": "ID_DesignModel_Timber",
        "birthDatedivisionId": "0000-00-00ac21b9a1-8853-4658-9fbf-0cf62340bd18",
        "address": {
            "streetdivisionName": "WestermeierModel str.1",
            "streetNrdivisionTopologyId": "1060c8362a-eb91-412d-ac67-c5d787bf36cb",
            "ziprevisions": "81829",[
            "city": "München",1,2
        ],
        "countryvisible": "Germany"false,
        }"opaque": false,
        "preferedLanguageopacity": "en"0
    },
   }, {
        "id": "6cea110a30114b52-88f4bc05-43ac47c1-9a0080b5-ebaf677be333c7d5485d5840",
       }

...

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
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

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
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

{
    "parent": null,
    "name": null,
    "type": "Project",
    "children": [
        {
     "name": "ID_FinishModel",
        "divisionId": "ac21b9a1-8853-4658-9fbf-0cf62340bd18",
        "divisionName": "Model 1",
        "divisionTopologyId": "60c8362a-eb91-412d-ac67-c5d787bf36cb",
        "revisions": [
            1,2
        ],
        "visible": false,
        "opaque": false,
        "opacity": 0
    },
    {
        "parentid": "0d2ce2cc09e623d4-35881e12-45d64a77-a59ab358-f6b89ebed34eea1d0b28e4a7",
        "name": "ID_RoomModel",
        "namedivisionId": null"ac21b9a1-8853-4658-9fbf-0cf62340bd18",
        "divisionName": "Model 1",
        "typedivisionTopologyId": "60c8362a-eb91-412d-ac67-c5d787bf36cb",
  "ID_TopologyDivision",      "revisions": [
            "children": [],
1
        ],
        "idvisible": "195db084-3715-4ebc-b164-3ee47a495b2e"false,
        }"opaque": false,
    ],
    "idopacity": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
}0
    }
]

Anchor

	getSpotListFromProjectgetProjectMaterialSurfacesgetSpotListFromProject
	getProjectMaterialSurfaces

Get

...

material surfaces of the project

Deck of Cards

id	bimGetSpotListFromProjectbimGetProjectMaterialSurfaces

true

Card

default

label	URL / Resource / JSON Structure

Resource: projects/<project_id>/

pins

materialsurfaces

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

Example: https://api-stage.bimplus.net/v2/bimplus/projects/586b02be0d2ce2cc-43b83588-4e2745d6-b698a59a-e067e85e38e2f6b89ebed34e/pinsmaterialsurfaces

Card

label	HTTP Method

GET

Card

label	Description

Get the spot list from the all material surfaces used in the project

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[{[
    {
        "issueId": "5eac4d92-c65b-49c8-927c-9f255879a5c2",
    "diffuseColor":8421504,
    "objectIdtransparency": "442af981-4175-4f1d-90f0-ef1c8641f0cb"0,
        "topologyNodeIdargb": "4be5ffd3-1e5e-42a7-9844-23b55fb39253"-8355712,
    "reflection":0,
    "positionrefraction": {1,
    "scaleX":0,
        "xscaleY": 78696.440,
            "ytranslateX": 9652.2510,
            "ztranslateY": 5800,
        }"rotation":0,
        "normalVectordiffuseReflectivity": {100,
      "colorKeyTolerance":0,
      "xmultiToneFactor": 0,
    "colorMixing":false,
    "alphaFromTexture":true,
    "yuseColorKey": 0false,
    "repeat":true,
    "metric":true,
    "zemission": 10,
    "bumpAmplitude":0,
    }"roughness":0,
    "colorKey":0,
    "createdAttextures": "2014-05-09T12:17:18",[{
        "idobjectIds": ["3ba43939cdbd7fbc-58050d02-4aac4be5-b7a5adb3-8cf3b5833ac304b7f0b2a638"
    },
    {],
        "issueIdfileName": "5333bb42diffuse-2cb9-4f11-afd8-120c79edef37texture-image.jpg",
        "objectIdtype": "ae1a139a-1e13-491f-b6d8-a46f699e295e""image/jpeg",
        "size":31590,
        "topologyNodeIdcreatedAt": "37a26e8b2016-566e-4d6e-8ab2-f35a715e83e212-06T18:44:57.143",
        "positioncreator": {
            "xid": 41677.4336"78a94d0e-0d58-3f85-aafa-1e631c51b5d2",
            "yemail": 10095.9512null,
            "zfirstname": -9020null,
        },
        "normalVector"lastname": {null,
            "xcompany": 0null,
            "yfullname": 0"",
            "zdisplayname": 1null
        },
        "createdAtchanged": "20142016-0512-09T1206T18:17:33",44:57.143",
        "changedBy":{
          "id": "fa9acf2678a94d0e-efdf0d58-42973f85-80b5aafa-2422bbf6e35a1e631c51b5d2",
      },
    "email":null
        {},
        "issueIdhash": "5eac4d92de78a77e-c65b8bc7-49c84ffa-927cb4ac-9f255879a5c2a201b100a1ed",
        "objectIdattachmentType": "effc5f9f-dcae-4e5f-9a67-189d4a285612"AllplanResource",
        "topologyNodeIdtag": "4be5ffd3-1e5e-42a7-9844-23b55fb39253"eDIFFUSE1|eDIFFUSE2|eDIFFUSE3|eDIFFUSE4",
        "positionsizeMB": {"0,03",
        "version":1,
        "xrelatedId": -440,
    "cdbd7fbc-0d02-4be5-adb3-04b7f0b2a638",
        "y": 10767.11,id":"1eeec814-bb81-4876-a608-fc28f864984f"
      }
    ],
  "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
        },  "id":"cdbd7fbc-0d02-4be5-adb3-04b7f0b2a638"
  },
  ...
]

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

Headers and content are the same as for Create attachment

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

borderColor	Red
lang	xml
title	JSON

{
  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
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Response content type is the same as is the "type" of the thumbnail, e.g. "image/jpeg"

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
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[
    {
        "createdAtname": "2014-05-21T13:34:07TestStructure",
        "iddescription": "2b693990-a611-4b05-9efd-7485a9aeebbb"
    },
    {FullLifeCycleTest",
        "issueIdtype": "5eac4d92-c65b-49c8-927c-9f255879a5c2CostStructure",
        "objectIdnr": "83821c97-0020-480e-b863-9981df590c0a"1,
        "topologyNodeIdcolor": "aa7e1b6f-7324-459b-a114-9833806f89ed"0,
        "positionid": {
            "x": 664.999939,"179439d6-df16-41cc-bd2c-74d05b7995d5"
            "y": 7197.733},
    {
        "zname": -58535.82"TestStructure2",
        }"description": "Another Structure",
        "normalVectortype": {"SpecificationStructure",
            "xnr": -12,
            "ycolor": 0,
        "id": "279439d6-df16-41cc-bd2c-74d05b7995d5"
    "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
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

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 of a project.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Description

Get the topology of all structures belonging to a specified project

Status: 200 OK

Card

label	Request

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Code Block

borderColor	RedGreen
lang	xml
title	JSON	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

{
    "parent[
    {
        "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,
        "revisionsname": []
"Test for   }Structure",
    {"type": "ID_Project",
        "idchildren": "30114b52-bc05-47c1-80b5-c7d5485d5840",[
        "name": "ID_FinishModel",
{
            "divisionIdparent": "ac21b9a1622272da-8853f1ff-465845ab-9fbfa3f0-0cf62340bd18c8f1255c80e8",
        "divisionName": null,
        "revisionsname": []
    }"TestStructure",
    {
        "idtype": "09e623d4-1e12-4a77-b358-ea1d0b28e4a7Structure",
        "name": "ID_RoomModel",
         "divisionIdchildren": "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
lang	xml
title	Headers

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

Thumbnail API call:

Image Removed

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

borderColor	Red
lang	xml
title	JSON

{
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
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

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
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[
    {
         "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",
                                    "namechildren": "TestStructure"[],
        "description                            "id": "FullLifeCycleTest",
df4a81d6-42fb-4187-bbce-82a2fc093b2f"
              "type": "CostStructure",
                  }
                  "nr": 1,
          ],
          "color": 0,
                  "id": "179439d635b986c2-df16e9cd-41cc482e-bd2c9281-74d05b7995d56000671a49f0"
    },
    {
        "name": "TestStructure2",
       }
 "description": "Another Structure",
        "type": "SpecificationStructure",
        "nr": 2],
         "color": 0,
           "id": "279439d6adf506ae-df163628-41cc4501-bd2c9af1-74d05b7995d522bcf27e4ab4"
    }
]

...

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

...

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
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

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

topology

hyperlinks

URLExample: https://api-stage.bimplus.net/v2/<team_slug>bimplus/structures/<project_id>/topologyExample: 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
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

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

Anchor

	getAllCommentsdeleteProjectgetAllComments
	deleteProject

...

Delete the project

Deck of Cards

id	bimGetAllCommentsbimDeleteProject

Card

default	true
label	URL / Resource / JSON Structure

Resource: comments, hyperlinksprojects/<project_id>

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

Example: https://api-stage.bimplus.net/v2/bimplus/projects/db540336-47a3-426e-b3bf-1e532bfac8ea>/comments OR https://api-stage.bimplus.net/v2/bimplus/projects/db540336-47a3-426e-b3bf-1e532bfac8ea>/hyperlinks0d2ce2cc-3588-45d6-a59a-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
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

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

...

Delete the project

...

id	bimDeleteProject

Anchor
ProjectActionsRights
ProjectActionsRights

Get project actions rights

Deck of Cards

id	bimProjectActionsRights

Card

default	true
label	URL / Resource / JSON Structure

Resource: project-actions-rights

URL: https://api-stage.bimplus.net/v2/project-actions-rights

Card

label	HTTP Method

GET

Card

label	Description

Purpose of this API call is to get required project rights for a Bimplus action.
This is a static API call, meaning it's global for all the projects, and the response can only change after the deploy.

Returns list of pairs of :
- name of the action ( event )
- required right the user must have for a project, to be able to execute that action

Currently used project rights are:
- ProjectAdmin
- ProjectDelete
- ProjectEdit
- ProjectView
- ModelViewAll
- ModelCreate

Clients can use this API to automatically handle access to Bimplus actions according to the role the user have in the project, e.g. enable/disable action buttons, ...

And if Bimplus server will decide to change required project user rights for some action, this change will be reflected on the client automatically, without having to change the client's code.

Important note:

this call does not includes all the Bimplus actions, but mostly those related to project and issues : actions of projects, models, issues, attachments, comments, pins, slides, slideshows, bcf, ..

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[
  {
    "action": "UPDATE_PROJECT",
    "right": "ProjectEdit"
  },
  {
    "action": "DELETE_PROJECT",
    "right": "ProjectDelete"
  },
  {
    "action": "CREATE_MODEL",
    "right": "ModelCreate"
  },
  {
    "action": "UPDATE_MODEL",
    "right": "ProjectEdit"
  },
  {
    "action": "GET_MODEL",
    "right": "ProjectView"
  },
  {
    "action": "DELETE_MODEL",
    "right": "ProjectEdit"
  },
  {
    "action": "DOWNLOAD_MODEL",
    "right": "ProjectView"
  },
  {
    "action": "CREATE_ISSUE",
    "right": "ProjectEdit"
  },
  {
    "action": "GET_PROJECT_ISSUES",
    "right": "ProjectView"
  },
  {
    "action": "DELETE_PROJECT_ISSUES",
    "right": "ProjectAdmin"
  },
  {
    "action": "CREATE_COMMENT",
    "right": "ProjectEdit"
  },
  ...
]

Anchor

	FilteringAndPaging
	FilteringAndPaging

Filtering and paging

Filtering and paging is implemented for following requests:

get list of projects
get project attachments
get project issues ( only paging, not filtering )

Paging

Using following query parameters :

page - requested number of page
pageSize - size of page
sortColumn - name of the column ( property ) by which the list is sorted
sortDirection - asceding or descending

Examples :

GET https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/attachments?page=1&pageSize=5&sortColumn=fileName&sortDirection=descending

GET https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/issues?page=2&pageSize=10

GET https://api-stage.bimplus.net/v2/<team_slug>/projects?sortColumn=name&sortDirection=ascending

Filtering :

Using a filter added as a query parameter. Filter has following format : ?filter=<property><operator><value>

For the "property" you may use any property of the requested resource, or even inner property, e.g. creator.Email

Supported operators are : "=", "!=", "<", ">", ">=", "<=" and "*"

It is also possible to combine expressions in filter using AND operator : ?filter=<property1><operator1><value1>%26<property2><operator2><value2>%26,,,

The %26 is just url encoding of '&' = AND. The encoding is required because otherwise it will be considered as another query parameter, and not part of a filter. Combination using OR is not supported

Examples :

GET https://api-stage.bimplus.net/v2/<team_slug>/projects?filter=name=MyProject - get project by name

GET https://api-stage.bimplus.net/v2/<team_slug>/projects?filter=name=MyProject* - get projects where name starts with "MyProject"

GET https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/attachments?filter=size>500000 - get attachments with size greater then ...

...

default	true
label	URL / Resource / JSON Structure

...

GET

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
lang	xml
title	Headers

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

...

label	Response

...

borderColor	Green
lang	xml
title	Status

...

/attachments?filter=creator.email=myuser@allplan.com%26createdAt>2016-07-27T07:00:00 - get attachments created by the given user since the time

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 28

New Version Current

Key

Project Service

Create copy of the source project

Get the logged in user's project List

Get the user's project list from a team

Get the user's project list from a team

Get the Project Properties

Get the Project Properties

Update the project

Create an issue in the project with a view

Get the Issue List from the project

Delete all the issues from the project

Create a new attachment in the project

Create a new attachment in the project using chunked upload

Get the Attachment List from the project

Delete all the attachments from the project

Get the project topology tree

Update the project

Create an issue in the project with a view

Get the spot list

from the project

Delete all the issues from the project

Create a new attachment in the project

Get the

project disciplines

Delete all the attachments from the project

Get the project topology tree

Get

material surfaces of the project

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

AnchorProjectActionsRightsProjectActionsRights

Get project actions rights

Filtering and paging

Anchor
ProjectActionsRights
ProjectActionsRights