Page History

...

Section

border	true

Column

Project relevant services

Column

Administration relevant services

Column

Other services

Section

Column

Project Service

Column

Model Service

Column

Object Service

Section

Column

ElementType Service

Column

Attachment Service

Column

Issue Service

Column

Pin Service

...

Section

Column

width	25%

Messaging Service

Column

width	25%

Log Service

Column

width	50%

Bimplus Windows Explorer related Services

...

Hyperlink Service

A particular hyperlink belonging to an object/slide/issue can be modified using the hyperlink service.

Please use the Bimplus Object Service for creating a hyperlink or to deal with the group of hyperlinks belonging to an object, issue or slide.

...

Get details of the hyperlink

Deck of Cards

id	bimGetHyperlink

Card

default	true
label	URL / Resource / JSON Structure

Resource: hyperlink/<hyperlink_id>

URL: https://api-stage.bimplus.net/v2/<team_slug>/hyperlinks/<hyperlink_id>

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

Card

label	HTTP Method

GET

Card

label	Description

Get details of a specified hyperlink.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "orderNumber": 1,
    "name": "My website",
    "url": "https://www.bimplus.net/",
    "id": "c46d1080-0450-4f03-aa4d-a32300e018e9"
}

...

Update the hyperlink

Deck of Cards

id	bimHyperlinkUpdate

Card

default	true
label	URL / Resource / JSON Structure

Resource: hyperlink/<hyperlink_id>

URL: https://api-stage.bimplus.net/v2/<team_slug>/hyperlinks/<hyperlink_id>

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

JSON Structure:

Name	Mandatory / Optional	Type	Description
orderNumber	optional	integer	The ordering number of the hyperlink
name	optional	string	Name of the hyperlink
url	optional	string	The actual url
id	will be ignored	string (guid)	Id of the hyperlink

Card

label	HTTP Method

PUT

Card

label	Description

Update the specified hyperlink.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Code Block

borderColor	Red
title	JSON
lang	xml

{    
    "name": "My new website",
    "url": "https://www-stage.bimplus.net/"
}

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

...

Delete the hyperlink

Deck of Cards

id	bimDeleteHyperlink

Card

default	true
label	URL / Resource / JSON Structure

Resource: hyperlink/<hyperlink_id>

URL: https://api-stage.bimplus.net/v2/<team_slug>/hyperlinks/<hyperlink_id>

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

Card

label	HTTP Method

DELETE

Card

label	Description

Deletes a specified hyperlink.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

...

Structure Service

A hierarchical tree structure(eg: cost structure) could be added and later retrieved from a project/object using the Structure service

...

Create a new structure in a project

...

id	bimcreateStructure

...

default	true
label	URL / Resource / JSON Structure

...

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

Example:https://api-stage.bimplus.net/v2/bimplus/projects/622272da-f1ff-45ab-a3f0-c8f1255c80e8/structures

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
type	optional	string	Type of the structure (eg: costStructure, specificationStructure)
nr	will be ignored	integer	The index of the structure
color	optional	integer	Color of the structure
id	will be ignored	string(guid)	Unique guid of the structure

Card

label	HTTP Method

POST

Card

label	Description

Create a new structure(eg: cost structure, specification structure) under a project

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "name": "TestStructure",
    "description": "FullLifeCycleTest",
    "type": "CostStructure"
}

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 201 Created

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "parentId": "622272da-f1ff-45ab-a3f0-c8f1255c80e8",
    "name": "TestStructure",
    "description": "FullLifeCycleTest",
    "type": "CostStructure",
    "nr": 1,
    "color": 0,
    "id": "179439d6-df16-41cc-bd2c-74d05b7995d5"
}

...

Get the structure details

Deck of Cards

id	bimGetStructureDetails

Card

default	true
label	URL / 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/179439d6-df16-41cc-bd2c-74d05b7995d5

Card

label	HTTP Method

GET

Card

label	Description

Get details of a specified structure.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "name": "TestStructure",
    "description": "FullLifeCycleTest",
    "type": "CostStructure",
    "nr": 1,
    "color": 0,
    "id": "179439d6-df16-41cc-bd2c-74d05b7995d5"
}

...

Create a sub-node under the structure

...

id	bimcreateSubStructure

...

default	true
label	URL / Resource / JSON Structure

...

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

Example:https://api-stage.bimplus.net/v2/bimplus/structures/179439d6-df16-41cc-bd2c-74d05b7995d5

JSON Structure:

Name	Mandatory / Optional	Type	Description
parentId	mandatory	string(guid)	Parent node id of the structure (the id specified in the resource url)
name	mandatory	string	Name of the structure
description	optional	string	Description of the structure
type	optional	string	Type of the structure (eg: costStructure, specificationStructure)
nr	will be ignored	integer	The index of the structure
color	optional	integer	Color of the structure
id	will be ignored	string(guid)	Unique guid of the structure

Card

label	HTTP Method

POST

Card

label	Description

Create a sub-node under a particular structure

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Code Block

borderColor	Red
title	JSON
lang	xml

{
  "name": "Node 1"
}

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 201 Created

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "parentId": "179439d6-df16-41cc-bd2c-74d05b7995d5",
    "name": "Node 1",
    "type": "TopologyStructure",
    "nr": 1,
    "color": 0,
    "id": "adf506ae-3628-4501-9af1-22bcf27e4ab4"
}

...

Get the structure topology

Deck of Cards

id	bimGetStructureTopology

Card

default	true
label	URL / Resource / JSON Structure

Resource: structures/<structure_id>/topology

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

Example:https://api-stage.bimplus.net/v2/bimplus/structures/179439d6-df16-41cc-bd2c-74d05b7995d5/topology

Card

label	HTTP Method

GET

Card

label	Description

Get details of a specified structure.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "parent": null,
    "name": "TestStructure",
    "type": "Structure",
    "children": [
        {
            "parent": "179439d6-df16-41cc-bd2c-74d05b7995d5",
            "name": "Node 1",
            "type": "Structure",
            "children": [],
            "id": "adf506ae-3628-4501-9af1-22bcf27e4ab4"
        }
    ],
    "id": "179439d6-df16-41cc-bd2c-74d05b7995d5"
}

...

Assign an object to the latest/last structure node

...

id	bimassignStructure

...

default	true
label	URL / Resource / JSON Structure

...

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

Example:https://api-stage.bimplus.net/v2/bimplus/structures/179439d6-df16-41cc-bd2c-74d05b7995d5/assign/df4a81d6-42fb-4187-bbce-82a2fc093b2f

JSON Structure:

Name	Mandatory / Optional	Type	Description
structureId	will be ignored	string(guid)	The id of the last node to which an object will be assigned
objectId	will be ignored	string(guid)	The id of the object to whom a structure will be assigned
name	mandatory	string	The name of the structure-object connection
nr	will be ignored	integer	The index of the structure-object connection
id	will be ignored	string(guid)	Unique guid of the structure-object connection

Card

label	HTTP Method

POST

Card

label	Description

Assign an object to the latest/last structure node

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Code Block

borderColor	Red
title	JSON
lang	xml

{
  "name": "WallConnection"
}

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 201 Created

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "structureId": "adf506ae-3628-4501-9af1-22bcf27e4ab4",
    "objectId": "df4a81d6-42fb-4187-bbce-82a2fc093b2f",
    "name": "WallConnection",
    "nr": 1,
    "id": "35b986c2-e9cd-482e-9281-6000671a49f0"
}

...

Update the structure

Deck of Cards

id	bimUpdateStructure

Card

default	true
label	URL / 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/179439d6-df16-41cc-bd2c-74d05b7995d5

JSON Structure:

Name	Mandatory / Optional	Type	Description
parentId	optional	string(guid)	Parent node id of the structure (for the first structure, projectId is the parentId)
name	optional	string	Name of the structure
description	optional	string	Description of the structure
type	optional	string	Type of the structure (eg: costStructure, specificationStructure)
nr	optional	integer	The index of the structure
color	optional	integer	Color of the structure
id	will be ignored	string(guid)	Unique guid of the structure

Card

label	HTTP Method

PUT

Card

label	Description

Update the specified structure

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Code Block

borderColor	Red
title	JSON
lang	xml

{
  "name": "Updated Structure"
}

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "parentId": "622272da-f1ff-45ab-a3f0-c8f1255c80e8",
    "name": "Updated Structure",
    "description": "FullLifeCycleTest",
    "type": "CostStructure",
    "nr": 1,
    "color": 0,
    "id": "179439d6-df16-41cc-bd2c-74d05b7995d5"
}

...

Delete the structure

Deck of Cards

id	bimDeleteStructure

Card

default	true
label	URL / 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

label	HTTP Method

DELETE

Card

label	Description

Deletes a specified structure.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

...

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.

...

Detect the clashes in a project

...

id	bimDetectClash

...

default	true
label	URL / Resource / JSON Structure

...

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
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

label	HTTP Method

POST

Card

label	Description

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

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "runAsync": "True",
    "postProcess": {
        "projectId": "0c9b514a-5b30-4f77-b0ff-2184d079fd30"
    }
}

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 Ok

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "postProcess": {
        "projectId": "0c9b514a-5b30-4f77-b0ff-2184d079fd30"
    },
    "runAsync": false
}

Anchor

	authorizationService
	authorizationService

...

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 554

New Version 555

Key

Project relevant services

Administration relevant services

Other services

Project Service

Model Service

Object Service

ElementType Service

Attachment Service

Issue Service

Pin Service

Messaging Service

Log Service

Bimplus Windows Explorer related Services

Hyperlink Service

Get details of the hyperlink

Update the hyperlink

Delete the hyperlink

Structure Service

Create a new structure in a project

Get the structure details

Create a sub-node under the structure

Get the structure topology

Assign an object to the latest/last structure node

Update the structure

Delete the structure

Clash Service

Detect the clashes in a project