URL parameters

Position ID of the object.

Example: https://<server>:<port>/#/p/<projectGUID>/model?positionId=722-PS1

Tag of the object.

Example: https://<server>:<port>/#/p/<projectGUID>/model?positionId=722-PS1&tag=.n5

Example: https://<server>:<port>/#/p/<project id>/model?groupParentTag=[sys]&groupChildTag=sys&groupId=Air

If the following string finds only one instance, it opens the object in examine mode:

Example: https://<server>:<port>/#/p/<projectGUID>/model?tag=len&attributeValue=1950

If the following string finds multiple instances, the search page opens:

Example: https://<server>:<port>/#/p/<projectGUID>/model?tag=len&attributeValue=619 --> Multiple hits opens search page

If the following string finds a group, it opens in examine mode:

Example: https://<server>:<port>/#/p/<projectGUID>/model?tag=[pli]&attributeValue=177-035

Show – shows the properties pane

Hide – hides the properties pane.

Example: https://<server>:<port>/#/p/<projectGUID>/model?attributePaneVisibility=Show

Define the complete path to the branch in the model tree, starting from "Models".

Separate the branches with three semicolons (;;;).

Use the hierarchyName parameter to define the source hierarchy of the given path.

Example: https://<server>:<port>/#/p/<project id>/model?examineBranchPath=Models;;;Branch1;;;Branch2&hierarchyName=Isometric%20Drawings%20and%20Spools

0 = Disable orbiting, show all objects

1 = Enable orbiting, show all objects

2 = Disable orbiting, hide other objects

4 = Dim all objects that are not being examined

8 = Turn off highlighting for the examined objects

16 = Turn off the X-ray mode for the examined objects

32 = Open the examined objects in clip box

64 = Clear the selection highlight of the examined objects and show the objects according to the applied visual style

For example, if the position ID of an object in the 3D model is "P001", you can use the following kind of URL to start examining that object so that orbiting is enabled and also all other objects are visible:

Example: https://<server>:<port>/#/p/<projectGUID>/model?positionId=P001&examineFlags=1

Name of the hierarchy.

Example: https://<server>:<port>/#/p/<project id>/model?hierarchyName=Isometric%20drawings%20and%20spools sets the hierarchy to "Isometric drawings and spools".

GUID id of the object or group.

Example: https://<server>:<port>/#/p/<projectGUID>/model?guidId=A491C908-AFF2-4369-BE2E-D7BB1F3A974A

Point cloud CPX file name.

Example: https://<server>:<port>/#/p/<projectGUID>/model?pointCloud=example.cpe.[000].%7B%d%7D.cpx

Smart Point ID.

Example: https://<server>:<port>/#/p/<projectGUID>/model?pointId=654321

pointReference should be given the desired point's exact External Id, and poiKind can be used to specify the type of the point.

pointReference can be used without poiKind, but poiKind cannot be used on its own.

Example: https://<server>:<port>/#/p/<project id>/model?pointReference=ID1234&poiKind=SmartPointType1

Markup ID

Example: https://<server>:<port>/#/p/<projectGUID>/model?markupId=123456

Objects' attribute abbreviation and value. In case of group objects, use the parent attribute abbreviation. Separate the objects with a vertical bar (|) and the attribute abbreviations and values with a colon (:).

Example: http://<server>:<port>/#/p/<project id>/model?multiExamine=.n5:AE-SW-P001|.n5:722-PS1|.n5:722-PS2|[sys]:722-SWC|.ne:R110202

With searchScope the types are separated with a comma, and are case-insensitive. If searchScope is not given in the URL, but searchFor is, the default scope used is "objects, groups, points".

Available types are:

objects – search through the objects in the model; searchFor tries to match to the object's key attribute's value

groups – search through the groups in the model; searchFor tries to match to the group's key attribute's value

points – search through the points of interest (smart points, markups) in the model; searchFor tries to match the point's name value. If unsuccessful, it tries to match the point's external ID value.

smartPoints – search through the smart points in the model; searchFor tries to match the smart point's name value. If unsuccessful, it tries to match the smart point's external ID value.

smartPointsByName – search through the smart points in the model; searchFor tries to match the smart point's name value only

smartPointsById – search through the smart points in the model; searchFor tries to match the smart point's external ID value only

markups – search through the markups in the model; searchFor tries to match the markup's name value

The scope is iterated in the given order when finding a match. If a match or multiple matches is found in one type, the search is stopped, which means that possible other matches found in other types will not be found.

If there is a single match, eShare Model view will examine it. The parameter examineFlags can be used to alter the way an object is examined, but it will not do anything if the match is a Smart Point.

If there are multiple matches,eShare will take the user to search, where all found matches will be shown.

The parameters searchFor and searchScope can be combined with following old parameters:

tag – narrows down the search with objects and groups

poiKind – narrows down the search with points of interests

Examples:

<domain:port>/model?searchFor=exampleName&examineFlags=17

<domain:port>/model?searchFor=exampleName&searchScope=objects,smartPoints

<domain:port>/model?searchFor=exampleName&searchScope=points&poiKind=PoiKindName

<domain:port>/model?searchFor=exampleName&tag=sys

Show – shows the sidebar.

Hide – hides sidebar.

Example: https://<server>:<port>/#/p/<projectGUID>/model?treeVisibility=Show

Name of the visual style, can be the predefined or project-specific visual style.

Example: https://<server>:<port>/#/p/<projectGUID>/model?visualStyleName=Normal visual style