Page History

...

Model Service

...

A Model is basically a technical building plan which could be created or imported.

...

Deck of Cards

id	bimCreateModel

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects/<project_id>/divisions

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

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

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 EMPTY (Default, if none of above)
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
changedBy	will be ignored	JSON object	User who updated 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

POST

Card

label	Description

Creates a new model in project using project id.

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

borderColor	Red
lang	xml
title	JSON

{
    "name": "Model D",
    "description": "Creating a model via API",
    "projectId": "743a24f9-baaa-41b9-90b3-91717238043c",
    "topologyId": "0fb09e03-20fc-42d9-a60b-254803950519",
    "disciplines": [
        "0f106af0-a919-44c5-b211-15bd5ef620b6",
        "33826b01-c267-4b25-9f8e-79ac2953c443",
        "30114b52-bc05-47c1-80b5-c7d5485d5840",
        "09e623d4-1e12-4a77-b358-ea1d0b28e4a7"
    ],
    "url": "/bimplus/divisions/2e0ca9e9-dd11-48d0-bd31-5a65225fe28a/download",
    "fileType": "Ifc",
    "inputType": "UNKNOWN",
    "created": "2015-11-06T09:34:45",
    "createdby": {
        "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
        "email": "jayaraj.purushothaman@gmail.com"
    },
    "changed": "2015-11-06T09:39:04",
    "changedby": {
        "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
        "email": "jayaraj.purushothaman@gmail.com"
    },
    "size": 7216128,
    "sizeMB": "6,88",
    "importFileName": "SMC Building.ifc",
    "status": "DONE_REFRESHED",
    "id": "2e0ca9e9-dd11-48d0-bd31-5a65225fe28a"
}

...

Deck of Cards

id	bimDetectModelChange

Card

label	URL / Resource / JSON Structure

Resource: divisions/<division_id>

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

Card

label	HTTP Method

HEAD

Card

label	Description

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

...

Deck of Cards

id	bimDownloadModel

Card

default	true
label	URL / Resource / JSON Structure

Resource: divisions/<division_id>/download

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

Example: https://api-stage.bimplus.net/v2/bimplus/divisions/743a24f9-baaa-41b9-90b3-91717238043c/download

Query parameters

Name	Mandatory/Optional	Description
api-token	optional	If the client cannot use the token in the header of the request, token can be specified in query parameters e.g. <team_slug>/divisions/<division_id>/download?api-token=9c1874a62c974dcfa75e0132c423a088
revision	optional	Specify revision number, If set, the call will return the import file of the revision, otherwise it's the current import file.

Card

label	HTTP Method

GET

Card

label	Description

Download the already uploaded model. There also exists a GET method for downloading the model where you can pass the "token" as a query parameter.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Returns file data. The response is of Content-Type: application/octet-stream.

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

...

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 20

New Version Current

Key

Model Service