Versions Compared

Key

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

Clash Service

...

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.

...

Anchor
detectClash
detectClash

Detect the clashes in a project
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 the clashes in a project. This process will be called during model import automatically in the future. 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.
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Code Block
borderColorRed
titleJSON
langxml
{
    "runAsync": "True",
    "postProcess": {
        "projectId": "0c9b514a-5b30-4f77-b0ff-2184d079fd30"
    }
}
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 200 Ok
Code Block
borderColorRed
titleJSON
langxml
{
    "postProcess": {
        "projectId": "0c9b514a-5b30-4f77-b0ff-2184d079fd30"
    },
    "runAsync": false
}