Page History

...

Deck of Cards

id	bimGetIssueList

Card

label	HTTP Method

GET

...

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects/<project_id>issues

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

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

...

card

Card

label	Description

...

Get all the issues assigned to a specified project.

...

card

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

carddeck

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

[
    {
        "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"
    },
    {
        "projectId": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
        "name": "Geometry information missing for wall",
        "description": "The geometry information is missing for the wall in the kitchen",
        "author": "Mr. Architect",
        "status": "open",
        "createdAt": "2013-06-02T10:05:00+00:00",
        "dueDate": "2013-06-05T10:05:00+00:00",
        "solution": null,
        "classification": "",
        "priority": "high",
        "revision": null,
        "id": "a171bc90-b03f-4ddd-9794-cf77f424f4e2"
    }
]

Anchor

	deleteIssues
	deleteIssues

Delete all the issues from the project

Deck of Cards

id	bimDeleteIssueList

Card

label	HTTP Method

DELETE

...

card

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects/<project_id>issues

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

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

Card

label	Description

...

Delete all the issues belonging to a specified project.

...

cardcardcarddeck

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Anchor

	createAttachment
	createAttachment

Create a new attachment in the project

Deck of Cards

id	bimCreateAttachmentInProject

Card

label	HTTP Method

POST

...

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects/<project_id>/attachments

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

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

JSON Structure: Please note that all the information required for this call will be taken from the document that you attach and hence the request of this call has no body.

Name	Mandatory / Optional	Type	Description
objectIds	will be ignored	string	The id of the project objects to which the file has to be attached
fileName	will be ignored	string	Name of the file to be attached to the project
type	will be ignored	string	Mime type
size	will be ignored	integer	Size of the file to be attached to the project

...

card

Card

label	Description

...

card

Creates a new attachment in a project.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Image Modified

...

Card

card

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 201 Created

Code Block

borderColor	Red
title	JSON
lang	xml

[
    {
        "objectIds": [
            "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
        ],
        "fileName": "Building_Plan.jpg",
        "type": "image/jpeg",
        "size": 211258,
        "id": "6cea110a-88f4-43ac-9a00-ebaf677be333"
    }
]

Deck of Cards

Anchor

	getAttachments
	getAttachments

Get the Attachment List from the project

Deck of Cards

id	bimGetAttachmentListFromProject

Card

label	HTTP Method

GET

Card

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects/<project_id>/attachments

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

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

...

Card

label	Description

...

carddeck

Get all the attachments belonging to a specified project.

Card

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

[
    {
        "objectIds": [
            "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
        ],
        "fileName": "Building_Plan.jpg",
        "type": "image/jpeg",
        "size": 211258,
        "id": "6cea110a-88f4-43ac-9a00-ebaf677be333"
    }
]

Anchor

	deleteAttachments
	deleteAttachments

Delete all the attachments from the project

Deck of Cards

id	bimDeleteAttachmentListFromProject

Card

label	HTTP Method

DELETE

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects/<project_id>/attachments

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

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

...

Card

label	Description

...

Delete all the attachments belonging to a specified project.

...

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Card

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Card

Deck of Cards

Anchor

	getProjectTopology
	getProjectTopology

Get the project topology tree

Deck of Cards

id	bimGetProjectTopology

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects/<project_id>/topology

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

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

...

Card

label	Description

...

deck

Card

Get the project topology tree.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Card

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "parent": null,
    "name": null,
    "type": "Project",
    "children": [
        {
            "parent": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
            "name": null,
            "type": "ID_TopologyDivision",
            "children": [],
            "id": "195db084-3715-4ebc-b164-3ee47a495b2e"
        }
    ],
    "id": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
}

Card

Anchor

	getProjectDisciplines
	getProjectDisciplines

Get the project layers

Deck of Cards

id	bimGetProjectDisc

Card

label	HTTP Method

GET

Card

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects/<project_id>/disciplines

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

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

Card

Card

label	Description

...

Get the layers of a project.

...

deck

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Card

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

[
    {
        "id": "0f106af0-a919-44c5-b211-15bd5ef620b6",
        "name": "ID_BuildingModel",
        "divisionId": "ac21b9a1-8853-4658-9fbf-0cf62340bd18",
        "divisionName": null,
        "revisions": []
    },
    {
        "id": "63b069d2-81df-4418-91de-8a954fa12924",
        "name": "ID_DesignModel_Timber",
        "divisionId": "ac21b9a1-8853-4658-9fbf-0cf62340bd18",
        "divisionName": null,
        "revisions": []
    },
    {
        "id": "30114b52-bc05-47c1-80b5-c7d5485d5840",
        "name": "ID_FinishModel",
        "divisionId": "ac21b9a1-8853-4658-9fbf-0cf62340bd18",
        "divisionName": null,
        "revisions": []
    },
    {
        "id": "09e623d4-1e12-4a77-b358-ea1d0b28e4a7",
        "name": "ID_RoomModel",
        "divisionId": "ac21b9a1-8853-4658-9fbf-0cf62340bd18",
        "divisionName": null,
        "revisions": []
    }
]

Card

Anchor

	createThumbnail
	createThumbnail

Create / Upload a thumbnail to the project

Deck of Cards

id	bimCreateThumbnail

Card

label	HTTP Method

POST

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects/<project_id>/thumbnail

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

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

Card

Card

label	Description

...

deck

Card

Creates or uploads a thumbnail to the project.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Thumbnail API call:

Image Modified

Card

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 201 Created

Code Block

borderColor	Red
title	JSON
lang	xml

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

Card

Anchor

	downloadThumbnail
	downloadThumbnail

Download the thumbnail

Deck of Cards

id	bimGetProjectDisc

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects/<project_id>/thumbnail/download

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

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

...

Card

label	Description

...

Downloads the thumbnail.

...

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Card

...

Anchor

	deleteProject
	deleteProject

Delete the project

Deck of Cards

id	bimDeleteProject

Card

label	HTTP Method

DELETE

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects/<project_id>

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

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

Card

Card

label	Description

...

Deletes a specified project.

...

deck

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Card

Anchor

	objectService
	objectService

...

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 235

New Version 236

Key

Delete all the issues from the project

Create a new attachment in the project

Get the Attachment List from the project

Delete all the attachments from the project

Get the project topology tree

Get the project layers

Create / Upload a thumbnail to the project

Download the thumbnail

Delete the project