Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Section
Column

Project Service


Column

Model Service


Column

Object Service


...

Deck of Cards
idbimUpdateModel
Card
labelHTTP Method
 PUT
Card
defaulttrue
labelURL / Resource / JSON Structure
 Resource: divisions/<division_id>

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

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

JSON Structure

Name

Mandatory / Optional

Type

Description

name

mandatory

string

Name of the model

description

optional

string

Short description of the model

projectId

optional

string (guid)

Id of the project to which the model belongs

topologyIdoptionalstring (guid)Id of the topology to which the model belongs
disciplinesoptionalobjectThe discipline list of the model
Card
labelDescription
 Update or replace a specified existing model with a new one.
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Code Block
borderColorRed
titleJSON
langxml
{
 "name":"Model D", 
 "description":"Updating the model D"
}
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 200 OK

Anchor
downloadModel
downloadModel

Download the model
Deck of Cards
idbimDownloadModel
Card
labelHTTP Method
 GET
Card
defaulttrue
labelURL / Resource / JSON Structure
 

Resource: divisions 

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

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

Card
labelDescription
 Download the already uploaded model
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 200 OK
Code Block
borderColorRed
titleJSON
langxml
{
    "name": "Model A",
    "description": null,
    "projectId": "481338c4-81f2-45bc-864a-bcd048a13a4c",
    "topologyId": "149e81c4-5270-4b44-b25b-c65fa88a7f14",
    "disciplines": [
        "0f106af0-a919-44c5-b211-15bd5ef620b6",
        "09e623d4-1e12-4a77-b358-ea1d0b28e4a7"
    ],
    "ifcFile": "/bimplus-gmbh/divisions/e45412f8-cd22-4c7e-a5f8-410de55824e2/download",
    "id": "e45412f8-cd22-4c7e-a5f8-410de55824e2"
}

Anchor
deleteModel
deleteModel

...