Page History

...

Deck of Cards

id	bimGetModelList

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: divisions

URL: http://api-dev.bimplus.net/v2/<team_slug>/projects/<project_id>/divisions

Example: http://api-dev.bimplus.net/v2/bimplus-gmbh/projects/743a24f9-baaa-41b9-90b3-91717238043c/divisions

Card

label	Description

Gets the list of existing models inside a project.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

[
    {
        "name": "Model A - Vogel",
        "description": null,
        "projectId": "743a24f9-baaa-41b9-90b3-91717238043c",
        "topologyId": "fc4be8b1-bf85-4c6f-b9c2-bac6474ddb1d",
        "id": "d81494b9-9731-4d2e-8fbe-da62f5270182"
    },
    {
        "name": "Model B - house sketchup",
        "description": null,
        "projectId": "743a24f9-baaa-41b9-90b3-91717238043c",
        "topologyId": "2d20d707-9c18-44c0-92f4-282948cd5cf5",
        "id": "deec1913-2c6e-4580-a40f-7e1ad33a6300"
    },
    {
        "name": "Model C - Nemetschek",
        "description": null,
        "projectId": "743a24f9-baaa-41b9-90b3-91717238043c",
        "topologyId": "d762b01d-6e63-4c68-9192-fc62faccbe87",
        "id": "e687b45b-d90d-4361-94ab-baf269588c0a"
    }
]

Anchor

	getModelDetails
	getModelDetails

...

Deck of Cards

id	bimGetModelDetails

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: divisions/<division_id>

URL: http://api-dev.bimplus.net/v2/<team_slug>/divisions/<division_id>

Example: http://api-dev.bimplus.net/v2/bimplus-gmbh/divisions/e687b45b-d90d-4361-94ab-baf269588c0a

Card

label	Description

Get all the details of a model using its id.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "name": "Model C - Nemetschek",
    "description": null,
    "projectId": "743a24f9-baaa-41b9-90b3-91717238043c",
    "topologyId": "d762b01d-6e63-4c68-9192-fc62faccbe87",
    "disciplines": [
        "0f106af0-a919-44c5-b211-15bd5ef620b6",
        "09e623d4-1e12-4a77-b358-ea1d0b28e4a7"
    ],
    "id": "e687b45b-d90d-4361-94ab-baf269588c0a"
}

...

Anchor

	updateProjectgetModelDetails	updateProject

...

	getModelDetails

Get the list of discipines from the model

Deck of Cards

id	bimUpdateProjectbimGetModelDetails

Card

label	HTTP Method

PUT GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: divisions/<division_id>/disciplines

URL: http://api-dev.bimplus.net/v2/<team_slug>/divisions/<division_id>/disciplines

Example: http://api-dev.bimplus.net/v2/bimplus-gmbh/divisions/e687b45b-d90d-4361-94ab-baf269588c0a

JSON Structure:

Name	Mandatory / Optional	Type	Description
name	optional	string	Name of the project
shortDescr	optional	string	Short description of the project
created	will be ignored	string (date)	Creation date of the project
changed	will be ignored	string (date)	Changed date of the project

/disciplines

Card

label	Description

Update or replace a specified existing model with a new one Get all the details of a model using its id.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

[
    {
        "category": "/1/",
        "name":"Model D", 
 "description":"Updating the model D"
} "ID_BuildingModel",
        "ifcType": null,
        "id": "0f106af0-a919-44c5-b211-15bd5ef620b6"
    },
    {
        "category": "/2/",
        "name": "ID_RoomModel",
        "ifcType": null,
        "id": "09e623d4-1e12-4a77-b358-ea1d0b28e4a7"
    }
]

Anchor

	updateModel
	updateModel

Update the model

Deck of Cards

id	bimUpdateModel

Card

label	HTTP Method

PUT

Card

default	true
label	URL / Resource / JSON Structure

Resource: divisions/<division_id>

URL: http://api-dev.bimplus.net/v2/<team_slug>/divisions/<division_id>

Example: http://api-dev.bimplus.net/v2/bimplus-gmbh/divisions/e687b45b-d90d-4361-94ab-baf269588c0a

JSON Structure:

Name	Mandatory / Optional	Type	Description
name	optional	string	Name of the project
shortDescr	optional	string	Short description of the project
created	will be ignored	string (date)	Creation date of the project
changed	will be ignored	string (date)	Changed date of the project

Card

label	Description

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

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Code Block

borderColor	Red
title	JSON
lang	xml

{
 "name":"Model D", 
 "description":"Updating the model D"
}

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Anchor

	deleteModel
	deleteModel

Delete the model

Deck of Cards

id	bimDeleteModel

Card

label	HTTP Method

DELETE

Card

default	true
label	URL / Resource / JSON Structure

Resource: divisions/<division_id>

URL: http://api-dev.bimplus.net/v2/<team_slug>/divisions/<division_id>

Example: http://api-dev.bimplus.net/v2/bimplus-gmbh/divisions/e687b45b-d90d-4361-94ab-baf269588c0a

Card

label	Description

Deletes a specified project.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

...

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 344

New Version 345

Key

Get the list of discipines from the model

Update the model

Delete the model