Versions Compared

Old Version 498

changes.mady.by.user Jayaraj Purushothaman

Saved on

compared with

New Version 499

changes.mady.by.user Jayaraj Purushothaman

Saved on

Key

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

...

Section
bordertrue
Column

Project relevant services

Column

Administration relevant services

Column

Other services

...

Section
Column

Comment Service

Column
width25%

Import Service

Column
width25%

Slideshow Service

Column
width25%

Hyperlink Service

Section
Column
width25%

Structure Service

Column
width25%

Clash Service

Column
width50%

 

Section
Column
width25%

Authorization Service

Column
width25%

User Management Service

Column
width25%

Team Management Service

Column
width25%

Membership Management Service

...

Deck of Cards
idbimDeleteStructure
Card
labelHTTP Method
 DELETE
Card
defaulttrue
labelURL / Resource / JSON Structure

Resource: structures/<structure_id> 

URL: https://api-stage.bimplus.net/v2/<team_slug>/structures/<structure_id>

Example:https://api-stage.bimplus.net/v2/bimplus/structures/db540336-47a3-426e-b3bf-1e532bfac8ea

Card
labelDescription
 Deletes a specified structure.
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 200 OK

 

Anchor
clashService
clashService

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 after the clash process is completed. This process will be called during model import in the future.

 

Anchor
detectClash
detectClash

Create a new structure in a project
Deck of Cards
idbimDetectClash
Card
labelHTTP Method
 POST
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: services/postprocess 

URL: https://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

parentId

mandatory

string(guid)

Parent node id of the structure (for the first structure, projectId is the parentId)

name

mandatory

string

Name of the structure

description

optional

string

Description of the structure

typeoptionalstringType of the structure (eg: costStructure, specificationStructure)
nrwill be ignoredintegerThe index of the structure
coloroptionalintegerColor of the structure
idwill be ignoredstring(guid)Unique guid of the structure


Card
labelDescription
 Create a new structure(eg: cost structure, specification structure) under a project
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
{
    "parentId": "622272da-f1ff-45ab-a3f0-c8f1255c80e8",
    "name": "TestStructure",
    "description": "FullLifeCycleTest",
    "type": "CostStructure",
    "nr": 1,
    "color": 0,
    "id": "179439d6-df16-41cc-bd2c-74d05b7995d5"
}

 

Anchor
authorizationService
authorizationService

...