Page History

...

Section

Column

Project Service

Column

Model Service

Column

Object Service

...

Deck of Cards

id	bimCreateModel

Card

label	HTTP Method

POST

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/projects/743a24f9-baaa-41b9-90b3-91717238043c/divisions

JSON Structure:

Name	Mandatory / Optional	Type	Description
name	mandatory	string	Name of the projectmodel
shortDescrdescription	optional	string	Short description of the projectmodel
createdprojectId	will be ignored	string (dateguid)	Creation date Id of the project to which the model belongs
topologyId	optional	string (guid)	Id of the topology to which the model belongs
disciplines	optional	object	The discipline list of the model

Card

label	Description

Creates a new model.

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":"Creating a model via API"
}

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 201 Created

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "name": "Model D",
    "description": "Creating a model via API",
    "projectId": "743a24f9-baaa-41b9-90b3-91717238043c",
    "id": "afbb314f-fdde-43e7-9a49-90e16c1a6131"
}

Anchor

	getModelsgetModelListgetModels
	getModelList

Get the list of existing models inside a project

...

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

	getModelDetailsgetModelDisciplinesgetModelDetails
	getModelDisciplines

Get the list of discipines from the model

Deck of Cards

id	bimGetModelDetailsbimGetModelDisciplines

Card

label	HTTP Method

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

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

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

...

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:

will be ignoreddate)Changed date of the project

Name	Mandatory / Optional	Type	Description
name	optionalmandatory	string	Name of the projectmodel
shortDescrdescription	optional	string	Short description of the projectmodel
createdprojectId	will be ignoredoptional	string (dateguid)	Creation date Id of the project to which the model belongschanged
topologyId	optional	string (	guid)	Id of the topology to which the model belongs
disciplines	optional	object	The discipline list of the model

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

...

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 345

New Version 346

Key

Project Service

Model Service

Object Service

Get the list of existing models inside a project

Get the list of discipines from the model