Page History

...

Deck of Cards

id	bimGetModelDetails

Card

default	true
label	URL / Resource / JSON Structure

Resource: divisions/<division_id>

URL: https://api-stage.bimplus.net/v2/<team_slug>/divisions/<division_id>

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

Card

label	HTTP Method

GET

Card

label	Description

Get all the details of a model 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": "Model A - Vogel",
        "description": null,
        "projectId": "743a24f9-baaa-41b9-90b3-91717238043c",
        "topologyId": "fc4be8b1-bf85-4c6f-b9c2-bac6474ddb1d",
        "disciplines": [
            "0f106af0-a919-44c5-b211-15bd5ef620b6",
            "33826b01-c267-4b25-9f8e-79ac2953c443",
            "a330fde2-1a2f-48ed-a6e3-90b92965dca6"
        ],
        "url": "/my-company/divisions/d81494b9-9731-4d2e-8fbe-da62f5270182/download",
        "fileType" : "Unknown",
        "inputType" : "IFC_IMPORT",
        "created": "2015-07-07T09:21:15",
        "createdby": {
          "id": "7c555899-5a5f-44d1-930e-284930678bed",
          "email": "testuser@nemetschek.com"
        },
        "changed": "2015-07-07T09:21:16",
        "changedby": {
          "id": "7c555899-5a5f-44d1-930e-284930678bed",
          "email": "testuser@nemetschek.com"
        },
        "size": 39216128,
        "sizeMB": "37,4",
        "importFileName": "Vogel_bim.ifczip",
        "importFileSize": 12631230,
        "status" : "DONE",
        "id": "d81494b9-9731-4d2e-8fbe-da62f5270182"
    }

Anchor

	getModelDisciplinesdetectModelChange	getModelDisciplines

...

	detectModelChange

Detect model change

Deck of Cards

id	bimGetModelDisciplinesbimDetectModelChange

Card

default	true
label	URL / Resource / JSON Structure

Resource: divisions/<division_id>

/disciplines

URL: https://api-stage.bimplus.net/v2/<team_slug>/divisions/<division_id>/disciplinesExample: https://api-stage.bimplus.net/v2/bimplus-gmbh/divisions/e687b45b-d90d-4361-94ab-baf269588c0a/disciplines

Card

label	HTTP Method

GET

HEAD

Card

label	Description

Get all the details of a model 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

[
    {
        "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"
    }
]

...

This method checks if the model has changed or not, and returns model's current ETag.

In the request, include models ETag into http header "If-None-Match", and then the response will be :

a) 304 NotModified if current model's ETag is identical ( means model has not changed )

b) 200 OK if model has changed, and returns current models ETag as "ETag" header in the response.

The "If-None-Match" header is not mandatory. If not present, the response will always return 200 OK with current ETag.

Card

label	Request

Code Block

title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
If-None-Macth: "f9efd399-4631-4a77-b40a-31fb099f42a4"

Card

label	Response

Code Block

title	Status

Status: 304 NotModified - if model not changed
or 
Status: 200 OK - if model has changed, or "If-None-Match" header was not included in request

Code Block

title	Headers

Etag: "f9efd399-4631-4a77-b40a-31fb099f42a4"

Anchor

	getModelDisciplines
	getModelDisciplines

Get the list of discipines from the model

Deck of Cards

id	bimGetModelDisciplines

Card

default	true
label	URL / Resource / JSON Structure

Resource: divisions/<division_id>/disciplines

URL: https://api

...

Update the model

Deck of Cards

id	bimUpdateModel

Card

default	true
label	URL / Resource / JSON Structure

Resource: divisions/<division_id>

URL: https://api-stage.bimplus.net/v2/<team_slug>/divisions/<division_id>/disciplines

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

JSON Structure:

Name	Mandatory / Optional	Type	Description
id	will be ignored	string(guid)	Id of the model/division
name	mandatory	string	Name of the model
description	optional	string	Short description of the model
projectId	will be ignored	string (guid)	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
status	will be ignored	string(enum)	The status of the imported file. It could be one of the following PREPARING (Uploading the file) PENDING (Waiting in the queue after upload to be processed) PROCESSING (Processing) DONE (Processed) DONE_REFRESHED (Processed & sent the notification) FAILED UNKNOWN
revisionObjects	will be ignored	JSON Object	The list of revisions
teamSlug	will be ignored	string	Slug of the team to which the model belongs
url	will be ignored	string	The link for downloading the model
fileType	will be ignored	string	Content-type of file
inputType	will be ignored	string	Type of file (eg: ifc, Allplan etc)
created	will be ignored	string(date)	Creation date of the model
createdby	will be ignored	JSON object	The user who created this model
changed	will be ignored	string(date)	Update date of the model
size	will be ignored	int	size in bytes
sizeMB	will be ignored	string	size in MB
importFileName	will be ignored	string	The file name of the model

Card

label	HTTP Method

PUT

Card

label	Description

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

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":"Model D", 
 "description":"Updating the model D"
}

/disciplines

Card

label	HTTP Method

GET

Card

label	Description

Get all the details of a model 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

[
    {
        "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"
    }
]

Anchor

	updateModel
	updateModel

Update the model

Deck of Cards

id	bimUpdateModel

Card

default	true
label	URL / Resource / JSON Structure

Resource: divisions/<division_id>

URL: https://api-stage.bimplus.net/v2/<team_slug>/divisions/<division_id>

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

JSON Structure:

Name	Mandatory / Optional	Type	Description
id	will be ignored	string(guid)	Id of the model/division
name	mandatory	string	Name of the model
description	optional	string	Short description of the model
projectId	will be ignored	string (guid)	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
status	will be ignored	string(enum)	The status of the imported file. It could be one of the following PREPARING (Uploading the file) PENDING (Waiting in the queue after upload to be processed) PROCESSING (Processing) DONE (Processed) DONE_REFRESHED (Processed & sent the notification) FAILED UNKNOWN
revisionObjects	will be ignored	JSON Object	The list of revisions
teamSlug	will be ignored	string	Slug of the team to which the model belongs
url	will be ignored	string	The link for downloading the model
fileType	will be ignored	string	Content-type of file
inputType	will be ignored	string	Type of file (eg: ifc, Allplan etc)
created	will be ignored	string(date)	Creation date of the model
createdby	will be ignored	JSON object	The user who created this model
changed	will be ignored	string(date)	Update date of the model
size	will be ignored	int	size in bytes
sizeMB	will be ignored	string	size in MB
importFileName	will be ignored	string	The file name of the model
importFileSize	will be ignored	int	Size of the import file in bytes

Card

label	HTTP Method

PUT

Card

label	Description

Update specified model. Only name and description can be updated.

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":"Model D", 
 "description":"Updating the model D"
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

title	JSON

{
        "name": "Model D",
        "description": "Updating the model D",
        "projectId": "743a24f9-baaa-41b9-90b3-91717238043c",
        "topologyId": "fc4be8b1-bf85-4c6f-b9c2-bac6474ddb1d",
        "disciplines": [
            "0f106af0-a919-44c5-b211-15bd5ef620b6",
            "33826b01-c267-4b25-9f8e-79ac2953c443",
            "a330fde2-1a2f-48ed-a6e3-90b92965dca6"
        ],
        "url": "/my-company/divisions/d81494b9-9731-4d2e-8fbe-da62f5270182/download",
        "fileType" : "Unknown",
        "inputType" : "IFC_IMPORT",
        "created": "2015-07-07T09:21:15",
        "createdby": {
          "id": "7c555899-5a5f-44d1-930e-284930678bed",
          "email": "testuser@nemetschek.com"
        },
        "changed": "2015-07-07T09:21:16",
        "changedby": {
          "id": "7c555899-5a5f-44d1-930e-284930678bed",
          "email": "testuser@nemetschek.com"
        },
        "size": 39216128,
        "sizeMB": "37,4",
        "importFileName": "Vogel_bim.ifczip",
        "importFileSize": 12631230,
        "status" : "DONE",
        "id": "d81494b9-9731-4d2e-8fbe-da62f5270182"
    }

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Anchor

	downloadModel
	downloadModel

...

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 14

New Version 15

Key

Detect model change

Get the list of discipines from the model

Update the model

Update the model