Versions Compared

Key

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

...

Clash Service

...

Clashes could be detected in a project by calling this service. The person who uploaded the model which contains the clash will get a notification along with the clash count after the clash process is completed. This process will be called during model import in the future.

...

Deck of Cards
idbimDetectClash
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: services/postprocess 

URLhttps://api-stage.bimplus.net/v2/<team_slug>/services/postprocess

Example:https://api-stage.bimplus.net/v2/bimplus/services/postprocess

JSON Structure

Name

Mandatory / Optional

Type

Description

runAsync

mandatory

bool

True sets the clash process to run asynchronously

postProcess

mandatory

object

It runs as a windows service in the server

projectId

mandatory

string

Id of the project


Card
labelHTTP Method
 POST
Card
labelDescription
 Detects all the clashes in a project. Beware, that this will more time as they will be typically 100s of clashes in a model
Card
labelRequest
Code Block
borderColorGreen
langxml
titleHeaderslangxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Code Block
lang
borderColorRed
langxml
titleJSONxml
{
    "runAsync": "True",
    "postProcess": {
        "projectId": "0c9b514a-5b30-4f77-b0ff-2184d079fd30"
    }
}
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatuslangxml
Status: 200 Ok
Code Block
borderColorRed
langxml
titleJSON
langxml
{
    "postProcess": {
        "projectId": "0c9b514a-5b30-4f77-b0ff-2184d079fd30"
    },
    "runAsync": false
}

...

Deck of Cards
idbimDetectClashObjects
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: clashdetection

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

Example:https://api-stage.bimplus.net/v2/bimplus/clashdetection

JSON Structure

Name

Mandatory / Optional

Type

Description

layerid1

mandatory

string(guid)

Layer/discipline id

layerid2

mandatory

string(guid)

Layer/discipline id

tolerancex

optional

int

Id of the project

toleranceyoptionalintTolerance in x direction(mm)
objectsidmandatoryJSON ArrayTolerance in y direction(mm)


Card
labelHTTP Method
 POST
Card
labelDescription
 Detect clashes between disciplines & objects/topologies.
Card
labelRequest
Code Block
borderColorGreen
langxml
titleHeaderslangxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Code Block
borderColorRed
langxml
titleJSONlangxml
{
    "layerid1": "0F106AF0-A919-44c5-B211-15BD5EF620B6",
    "layerid2": "0F106AF0-A919-44c5-B211-15BD5EF620B6",
    "tolerancex": "15",
    "tolerancey": "25",
    "objectsid": [
        "a3105304-a785-4dff-b114-a57b665248f6",
        "f7fbde41-1c46-4c10-81cb-c97f16c9d16a",
        "aaf238a1-4a40-4185-991e-7673d82b040c"
    ]
}
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatuslangxml
Status: 201 Created
Code Block
lang
borderColorRed
langxml
titleJSONxml
{
    "clashcount": 4
}

Anchor
getAllClashFilters
getAllClashFilters

Get all clash filters for a team
Deck of Cards
idbimGetAllClashFilters