Page History

Project Service

...

Anchor

	projectService
	projectService

...

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	Request

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	StatusHeaders

StatusAuthorization: 200 OKBimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

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 entry",
        "thumbnail":"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

{
    "topicCount": 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",
        "teamSlugchangedby": "company1",{
        "modelCountid" : 3"e0837206-4bff-65d4-b79f-f3878c3567fd",
        "memberCountemail" : 3,
        "size" : 63488"demo@bimplus.net",
        "sizeMBfirstname" : "0.06bim+",
        "rightslastname": {
"a service by Allplan"
     },
    "projectAdminmodelCount": false2,
            "projectDeletememberCount": false1,
            "projectEdit"size": false32839680,
            "modelsCreate"attachmentsSize": false0,
            "modelsViewAllsizeMB": false"31.32",
        }
    },
    {"approvalProcess": 0,
        "id": "0d2ce2cc990d0772-35888b87-45d6479a-a59a9ed6-f6b89ebed34eb0b46a204301"
}

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

[
   ,
        "name": "Your Awesome Building",
        "shortDescr": "Example for creating a project",
        "thumbnail": "",
        "created": "0001-01-01T00:00:00",
        "createdby" : {
            "id": "7c555899586b02be-5a5f43b8-44d14e27-930eb698-284930678bede067e85e38e2",
            "emailname" : "testuser@bimplus.net"!!!!!_VORTEILSHAUS V40 SD45 Traufeingang",
        "shortDescr": "Hey, i am your favourite test entry",
        }"thumbnail": "",
        "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",
        "hasWriteAccesschangedby" : true,{
            "teamSlugid" : "best-company",
f4b1178d-385f-449c-a2a7-6f58b264d90c"
            "modelCountemail" : 4"owner@company1.com",
        "memberCount": 2},
        "address" : "Address of company 1"
        "hasWriteAccess": false,
        "teamSlug": "company1",
        "modelCount" : 3,
        "memberCount" : 3,
        "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

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": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
        "name": "Your Awesome Building",
        "shortDescr": "Example for creating a project",
        "thumbnail": "",
        "created": "0001-01-01T00:00:00",
        "createdby" : {
            "id": "0d2ce2cc7c555899-35885a5f-45d6-a59a-f6b89ebed34e",
        "name": "Your Awesome Building",
        "shortDescr": "Example for creating a project",
        "thumbnail": "",
        "created": "0001-01-01T00:00:00",
        "createdby" : {
            "id": "7c555899-5a5f-44d1-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": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
        "name": "Your Awesome Building",
        "shortDescr": "Example for creating a project",
        "thumbnail": "",
        "created": "0001-01-01T00:00:00    {
        "id": "4e87944a-a477-4e4c-862e-e723dcb43066",
        "name": "UC_Fly-over Kerensheide",
        "shortDescr": "",
        "thumbnail": "",
        "created": "2013-05-10T07:13:38",
        "createdby" : {
            "id": "bda91f097c555899-2cc65a5f-45da44d1-bba0930e-5f92828f58bc284930678bed",
            "email" : "UserA@bimplustestuser@bimplus.net"
        },
        "changed": "20130001-0501-16T0701T00:3400:5600",
        "changedby" : {
            "id": "7c555899-5a5f-44d1-930e-284930678bed",
            "email" : "testuser@bimplus.net"
        },
        "address" : "My address somewhere",
        "hasWriteAccess": true,
        "teamSlug": "best-company",
        "modelCount": 24,
        "memberCount": 32,
        "size" : 634884263936,
        "sizeMB" : "04,0607",
        "rights": {
            "projectAdmin": falsetrue,
            "projectDelete": falsetrue,
            "projectEdit": true,
            "modelsCreate": falsetrue,
            "modelsViewAll": true
        }
    },
]

...

Get the Project Properties

Resource: projects/<project_id>

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

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

Optional query parameters

Deck of Cards

id	bimGetProjectProp

Card

default	true
label	URL / Resource / JSON Structure

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": {
    {
        "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"},
        "changedbyaddress" : {""
        "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",
    "disciplines": [
        "rights": {
            "idprojectAdmin": "0f106af0-a919-44c5-b211-15bd5ef620b6"false,
            "nameprojectDelete": "ID_BuildingModel"false,
            "divisionIdprojectEdit": "b539790e-2ffc-43cd-9582-b4aa27b36693"true,
            "divisionNamemodelsCreate": "Model1"false,
            "divisionTopologyIdmodelsViewAll": "25f38274-7158-436d-9356-f5c917ee44c9",true
            "revisions": [}
    }
]

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": {            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
            ],
            "visibleid": false"71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "opaqueemail": false,"jayaraj.purushothaman@gmail.com"
    },
        "opacitychanged": 0
        }"2015-11-19T09:45:51",
       "changedby": {
            "id": "09e623d471e0ac3b-1e12fa49-4a77e540-b358ac2f-ea1d0b28e4a78caff3dd72ed",
            "nameemail": "ID_RoomModel",jayaraj.purushothaman@gmail.com"
        },
    "divisionIdaddress": "b539790e-2ffc-43cd-9582-b4aa27b36693",
    "modelCount": 1,
       "divisionNamememberCount": "Model1"7,
        "topicCount": 30,
    "divisionTopologyIdattachmentCount": "25f38274-7158-436d-9356-f5c917ee44c9"13,
    "size": 99317760,
       "revisionssizeMB": ["94,72",
    "disciplines": [
           1{
            ]"id": "0f106af0-a919-44c5-b211-15bd5ef620b6",
            "visiblename": false"ID_BuildingModel",
            "opaquedivisionId": false"b539790e-2ffc-43cd-9582-b4aa27b36693",
            "opacitydivisionName": 0"Model1",
        }
     ]"divisionTopologyId": "25f38274-7158-436d-9356-f5c917ee44c9",
      "rights      "revisions": {[
            "projectAdmin": true,
    1
          "projectDelete": true  ],
            "projectEditvisible": truefalse,
            "modelsCreateopaque": truefalse,
            "modelsViewAllopacity": true0
        },
        {
            "id": "5cd37c7730114b52-d341bc05-4ab247c1-9f0d80b5-44467955b218c7d5485d5840"
}

...

Update the project

...

id	bimUpdateProject

...

default	true
label	URL / Resource / JSON Structure

...

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

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

JSON Structure:

...

Name

...

Mandatory / Optional

...

Type

...

Description

...

name

...

mandatory

...

string

...

Name of the project

...

shortDescr

...

optional

...

string

...

Short description of the project

...

created

...

will be ignored

...

string (date)

...

Creation date of the project

...

Card

label	HTTP Method

PUT

Card

label	Description

Update properties of the specified project.

...

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

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

Anchor

	updateProject
	updateProject

Update the project

Deck of Cards

id	bimUpdateProject

...

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

...

Create an issue in the project with a view

See Create Issue in Topic Service

...

Get the Issue List from the project

...

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

...

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

This call also supports filtering and paging

...

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

...

Delete all the issues from the project

...

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.

...

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

...

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

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

Bimplus supports creating and updating of attachments only 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 :

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

Card

label	Request

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": "e18941f47c555899-a8095a5f-2d0144d1-d27d930e-cd251f2b6cb6284930678bed",
         "email" : "test@bimplustestuser@bimplus.net",
     },
     "hashchanged": "68a59c1f2013-1914-43b8-92fc-1cee4ad1c90c06-02T10:04:15",
     "attachmentTypechangedby" : "Document",{
        "classificationid" : "Report7c555899-5a5f-44d1-930e-284930678bed",
     "tag" : "ABCDE",
     "sizeMBemail" : "0,21",testuser@bimplus.net"
     "version" : "1"},
     "relatedIdaddress" : "0d2ce2cc-3588-45d6-a59a-f6b89ebed34eChanged address",
     "rightsmodelCount" : {
         "update" : true0,
         "sharememberCount" : true1,
    "topicCount": 0,
    "deleteattachmentCount" : true0,
         "downloadsize" : true0,
     }"sizeMB": "0",
     "id": "6cea110a0d2ce2cc-88f43588-43ac45d6-9a00a59a-ebaf677be333f6b89ebed34e"
}

Anchor

	createIssueInProject
	createIssueInProject

Create an issue in the project with a view

See Create Issue in Topic Service

Anchor

	getIssueList
	getIssueList	getAttachments	getAttachments

Get the

...

Issue List from the project

Deck of Cards

id	bimGetAttachmentListFromProjectbimGetIssueListFromProject

Card

default	true
label	URL / Resource / JSON Structure

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

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

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

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

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

[   
 {
   {

     "objectIds": [
   "name": "Wall info wrong",
  "author": {
    "id":  "0d2ce2cc7c555899-35885a5f-45d644d1-a59a930e-f6b89ebed34e284930678bed",
     ]"email": "testuser1@allplan.com",
     "fileNamefirstname": "TestFile.xmlTest",
     "typelastname": "application/xmlUser1",
     "sizecompany": 211258"Allplan Bratislava",
     "createdAtfullname": "2013-12-11T10:47:39",Test User1"
  },
   "creatorresponsible": {
         "id": "e18941f40132ecbe-a8092ac5-2d014ae1-d27d945d-cd251f2b6cb6d38fc3bc1e82",
         "email": "test@bimplustestuser1@allplan.netcom",
         "firstname": "First NameTest",
         "lastname": "Second NameUser2",
         "company": "Best-Company",
         "fullname": "First Name Second Name"Allplan Bratislava",
         "displaynamefullname": "Best-Company",Test User2"
     },
  "scene": null,
  "changedattachmentsCount" : "2013-12-11T10:47:39"0,
  "pinsCount": 0,
  "changedBycommentsCount" : {0,
  "hyperlinksCount": 0,
  "shortId": 4,
   "idprojectId": "e18941f4de87fc4d-a809cb5d-2d0144ba-d27db2ea-cd251f2b6cb61d96ac564a8a",
  "description": "This wall is wrong",
  "status": "Open",
  "emailcreatedAt": "test@bimplus.net2016-02-15T08:12:49.9831726+01:00",
     }"modifiedAt": "2016-02-15T08:12:49.9831726+01:00",
  "dueDate": null,
  "hashsolution": "68a59c1f-1914-43b8-92fc-1cee4ad1c90cMySolution",
  "type": "Problem",
  "attachmentTypeclassification" : "DocumentProblems",
     "classificationpriority" : "ReportHigh",
  "cc": [
  "tag" : "ABCDEabc@bimplus.net",
  ],
  "id": "sizeMB" : "0,21",
     "version" : "1",
     "relatedId" : "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

", "rights" : { "update" : true, "share" : true, "delete" : true, "download" : true }, "id": "6cea110a-88f4-43ac-9a00-ebaf677be333" }, ... ]

...

Delete all the attachments from the project

...

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.

...

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

...

Create a new objecttype in the project

...

id	bimCreateObjectTypeInProject

...

label	URL / Resource / JSON Structure

Resource: projects/<project_id>/objecttypes

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

Example: https://api-stage.bimplus.net/v2/bimplus/projects/e2120b81-aff4-4ac7-b53d-83676ccdbe7d/objecttypes

JSON Structure:

...

Name

...

Mandatory / Optional

...

Type

...

Description

...

name

...

mandatory

...

string

...

Name of the objecttype

...

description

...

optional

...

string

...

Description of the objecttype

...

Card

label	HTTP Method

POST

Card

label	Description

Creates a new objecttype in a project.

...

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":"UpdateTestObjectType",
  "definedBy":[{
      "id":"d5106d4d-0eba-4d20-86bd-7fe56f33fc76"
    },
    {
      "id":"2e5d5f07-6431-4bc6-b17c-49b5b8c585b7"
    }
  ]
}

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

borderColor	Red
lang	xml
title	JSON

{
  "id":"c7d15b4e-02da-42c6-a1be-9082d3668cda",
  "projectId":"e2120b81-aff4-4ac7-b53d-83676ccdbe7d",
  "type":"ModelType",
  "name":"TestObjectType",
  "customModeType":true,
  "definedBy":[{
      "name":"CommonMEP",
      "id":"d5106d4d-0eba-4d20-86bd-7fe56f33fc76"
    },
    {
      "name":"Heating",
      "id":"2e5d5f07-6431-4bc6-b17c-49b5b8c585b7"
    }
  ]
}

/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

...

Get all objecttypes from the project

Deck of Cards

id	bimGetObjectTypesFromProject

When query parameter "type=<type of the object type>" is defined, the API call will returns all objecttypes which have defined requested type.
Type of the objecttype can be one of the 'DocumentType', 'GroupType' or 'ModelType'
e.g:

URL:

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

bimplus

<team_slug>/projects

/e2120b81-aff4-4ac7-b53d-83676ccdbe7d/objecttypes?type=DocumentType

/<project_id>/attachments/chunked

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

e2120b81

aff4

4ac7

b53d

83676ccdbe7d/objecttypes?type=GroupType
https://api-stage.bimplus.net/v2/bimplus/projects/e2120b81-aff4-4ac7-b53d-83676ccdbe7d/objecttypes?type=ModelType

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects/<project_id>/objecttypes

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

Example: https://api-stage.bimplus.net/v2/bimplus/projects/e2120b81-aff4-4ac7-b53d-83676ccdbe7d/objecttypes

Optional query parameters:

Following query parameter allows reduce set of returned objecttypes. By default will be returned all defined objecttypes of the project.

Name

Type

Default value

Description

type

string

none

Card

label	HTTP Method

GET

Card

label	Description

Get allobjecttypes belonging to a specified project.

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.

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

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	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200201 OKCreated

Code Block

borderColor	Red
lang	xml
title	JSON

[{
{

     "objectIds": [
         "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
     ],
     "fileName": "TestFile.xml",
     "idtype":"ef37183d-8c74-473a-80de-03ba98b9eb6d" "application/xml",
     "size": 211258,
     "projectIdcreatedAt": "e2120b812013-aff4-4ac7-b53d-83676ccdbe7d12-11T10:47:39",
     "typecreator":"DocumentType",
 {
         "nameid":"Report "e18941f4-a809-2d01-d27d-cd251f2b6cb6",
         "descriptionemail": "documenttypetest@bimplus.net",
         "customModeTypefirstname":true
 "First }Name",
  {
       "idlastname":"d4d2204a-6352-4252-8b44-3746c0d7fd16 "Second Name",
         "projectIdcompany": "e2120b81-aff4-4ac7-b53d-83676ccdbe7d",
Best-Company",
         "typefullname":"DocumentType "First Name Second Name",
         "namedisplayname": "5486Best-Company",
    "customModeType":true
  },
  {
    "idchanged" : "0b3294782013-6643-474c-b580-41ccc9dad75012-11T10:47:39",
     "projectIdchangedBy":"e2120b81-aff4-4ac7-b53d-83676ccdbe7d", : {
         "typeid":"DocumentType "e18941f4-a809-2d01-d27d-cd251f2b6cb6",
     "name":"Specification",
    "descriptionemail": "documenttypetest@bimplus.net",
    "customModeType":true
  },
  {
    "idhash":"90d5c7d8-2430-4c87-984e-76ae4e8dd72a",
    "projectId":"e2120b81-aff4-4ac7-b53d-83676ccdbe7d"68a59c1f-1914-43b8-92fc-1cee4ad1c90c",
     "typeattachmentType" : "DocumentTypeDocument",
     "nameclassification" : "PresentationReport",
     "descriptiontag" : "documenttypeABCDE",
     "customModeTypesizeMB" :true
  } "0,21",
  {
    "idversion" :"64b85111-8570-45ca-9c30-86f85bfb666f "1",
     "projectIdrelatedId" : "e2120b810d2ce2cc-aff43588-4ac745d6-b53da59a-83676ccdbe7df6b89ebed34e",
     "typerights" :"DocumentType",
 {
         "update" : true,
         "nameshare" :"Contract" true,
         "descriptiondelete" :"documenttype" true,
         "customModeTypedownload" : true
     },
  ...
]     "id": "6cea110a-88f4-43ac-9a00-ebaf677be333"
}

Anchor

	updateObjectTypegetAttachments	updateObjectType

...

	getAttachments

Get the Attachment List from the project

Deck of Cards

id	bimUpdateObjectTypebimGetAttachmentListFromProject

Card

default	true
label	URL / Resource / JSON Structure

Resource: objecttypesprojects/<objecttype<project_id>/attachments

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

Example: https://api-stage.bimplus.net/v2/bimplus/objecttypesprojects/c7d15b4e0d2ce2cc-02da3588-42c645d6-a1bea59a-9082d3668cda

JSON Structure: See Create a new objecttype in the project

f6b89ebed34e/attachments

Card

label	HTTP Method

PUT

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	Description

Update properties of the specified objecttype.

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",
     "namesize":"UpdateTestModelType" 211258,
     "descriptioncreatedAt":"update "2013-12-11T10:47:39",
     "definedBycreator":[ {
         "id": "d5106d4de18941f4-0ebaa809-4d202d01-86bdd27d-7fe56f33fc76cd251f2b6cb6",
    }
  ]
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

title	JSON

{
  "idemail":"c7d15b4e-02da-42c6-a1be-9082d3668cda "test@bimplus.net",
  "projectId       "firstname":"e2120b81-aff4-4ac7-b53d-83676ccdbe7d "First Name",
         "typelastname": "ModelTypeSecond Name",
         "namecompany": "UpdateTestModelTypeBest-Company",
  "description       "fullname":"update",
  "customModeType":false "First Name Second Name",
  "definedBy":[{
       "namedisplayname": "CommonMEPBest-Company",
     },
     "idchanged" : "d5106d4d2013-0eba-4d20-86bd-7fe56f33fc76"
12-11T10:47:39",
     }
  ]
}

...

Get the objecttype

Deck of Cards

id	bimGetObjectType

Card

default	true
label	URL / Resource / JSON Structure

Resource: objecttypes/<objecttype_id>

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

Example: https://api-stage.bimplus.net/v2/bimplus/objecttypes/c7d15b4e-02da-42c6-a1be-9082d3668cda

Card

label	HTTP Method

GET

Card

label	Description

Get requested objecttype

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":"c7d15b4e-02da-42c6-a1be-9082d3668cda",
  "projectId":"e2120b81-aff4-4ac7-b53d-83676ccdbe7d",
  "type":"ModelType",
  "name":"UpdateTestModelType",
  "description":"update",
  "customModeType":true,
  "definedBy":[{
      "name":"CommonMEP",
 "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": "d5106d4d6cea110a-0eba88f4-4d2043ac-86bd9a00-7fe56f33fc76ebaf677be333"
    },
  ...
]
}

Anchor

	deleteObjectTypedeleteAttachmentsdeleteObjectType
	deleteAttachments

Delete all the attachments from the

...

project

Deck of Cards

id	bimDeleteObjectTypebimDeleteAttachmentListFromProject

Card

default	true
label	URL / Resource / JSON Structure

Resource: objecttypesprojects/<objecttype<project_id>/attachments

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

Example: https://api-stage.bimplus.net/v2/bimplus/objecttypesprojects/c7d15b4e0d2ce2cc-02da3588-42c645d6-a1bea59a-9082d3668cdaf6b89ebed34e/attachments

Card

label	HTTP Method

DELETE

Card

label	Description

Delete all the attachments belonging to a specified objecttypeproject.

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

...

Deck of Cards

id	bimGetProjectMaterialSurfaces

Card

label	URL / Resource / JSON Structure

Resource: projects/<project_id>/materialsurfaces

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

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

Card

label	HTTP Method

GET

Card

label	Description

Get 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

[{
    "diffuseColor":8421504,
    "transparency":0,
    "argb":-8355712,
    "reflection":0,
    "refraction":1,
    "scaleX":0,
    "scaleY":0,
    "translateX":0,
    "translateY":0,
    "rotation":0,
    "diffuseReflectivity":100,
    "colorKeyTolerance":0,
    "multiToneFactor":0,
    "colorMixing":false,
    "alphaFromTexture":true,
    "useColorKey":false,
    "repeat":true,
    "metric":true,
    "emission":0,
    "bumpAmplitude":0,
    "roughness":0,
    "colorKey":0,
    "textures":[{
        "objectIds":["cdbd7fbc-0d02-4be5-adb3-04b7f0b2a638"
        ],
        "fileName":"diffuse-texture-image.jpg",
        "type":"image/jpeg",
        "size":31590,
        "createdAt":"2016-12-06T18:44:57.143",
        "creator":{
          "id":"78a94d0e-0d58-3f85-aafa-1e631c51b5d2",
          "email":null,
          "firstname":null,
          "lastname":null,
          "company":null,
          "fullname":"",
          "displayname":null
        },
        "changed":"2016-12-06T18:44:57.143",
        "changedBy":{
          "id":"78a94d0e-0d58-3f85-aafa-1e631c51b5d2",
          "email":null
        },
        "hash":"de78a77e-8bc7-4ffa-b4ac-a201b100a1ed",
        "attachmentType":"AllplanResource",
        "tag":"eDIFFUSE1|eDIFFUSE2|eDIFFUSE3|eDIFFUSE4",
        "sizeMB":"0,03",
        "version":1,
        "relatedId":"cdbd7fbc-0d02-4be5-adb3-04b7f0b2a638",
        "id":"1eeec814-bb81-4876-a608-fc28f864984f"
      }
    ],
    "id":"cdbd7fbc-0d02-4be5-adb3-04b7f0b2a638"
  },
  ...
]

Anchor

	createThumbnail
	createThumbnail

...

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:

...

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

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 52

New Version Current

Key

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

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 an issue in the project with a view

Get the

Issue List from the project

Delete all the issues from the project

Delete all the attachments from the project

Create a new objecttype in the project

Create a new attachment in the project

Create a new attachment in the project using chunked upload

Get all objecttypes from the project

Get the Attachment List from the project

Get the objecttype

Delete all the attachments from the

project

Filtering and paging