Versions Compared

Key

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

...

Deck of Cards
idbimUpdateModel
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

idwill be ignoredstring(guid)Id of the model/division

name

mandatory

string

Name of the model

description

optional

string

Short description of the model

projectIdoptional

will be ignored

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
statuswill be ignoredstring(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
revisionObjectswill be ignoredJSON ObjectThe list of revisions
teamSlugwill be ignoredstringSlug of the team to which the model belongs
urlwill be ignoredstringThe link for downloading the model
fileTypewill be ignoredstringContent-type of file
inputTypewill be ignoredstringType of file (eg: ifc, Allplan etc)
createdwill be ignoredstring(date)Creation date of the model
createdbywill be ignoredJSON objectThe user who created this model
changedwill be ignoredstring(date)Update date of the model
sizewill be ignoredintsize in bytes
sizeMBwill be ignoredstringsize in MB
importFileNamewill be ignoredstringThe file name of the model
Card
labelHTTP Method
 PUT
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

...