Skip to main content

Creating hyperlinks to issues

Your application can show a link that opens an issue directly in the BIMcollab web app. For example, a dashboard can link each issue to its page in BIMcollab. This article explains how to build this link.

How it works

The Connection API doesn't return a link to the issue. You build the link yourself from three parts:

  • The space URL: the address of the BIMcollab space, for example https://yourspace.bimcollab.com.

  • The project ID: the GUID of the project that contains the issue.

  • The issue GUID: the GUID of the issue (topic).

Link format

<space-url>/WebApp/Desktop/User/Project/Issues/IssueDetails.aspx?project=<project-id>&issue=<issue-guid>


Build the link

Step 1: Get the project ID

Get the list of projects:

GET /bc_2.1/projects

Copy the project_id of your project.

Step 2: Get the issue GUID

Get the issues of the project:

GET /bc_2.1/projects/{project_id}/topics

Copy the globalId of the issue.

Step 3: Combine the parts

Add the space URL, project ID, and issue GUID to the link format.

Example:

Part

Value

Space URL

https://yourspace.bimcollab.com

Project ID

64736bed-2fdc-4d9f-a35e-91568623e71b

Issue GUID

c0542e35-537d-441c-88bd-af0ad1407666

Result:

https://yourspace.bimcollab.com/WebApp/Desktop/User/Project/Issues/IssueDetails.aspx?project=64736bed-2fdc-4d9f-a35e-91568623e71b&issue=c0542e35-537d-441c-88bd-af0ad1407666

Who can open the link?

The link opens the issue in the BIMcollab web app. The person who clicks the link must log in to BIMcollab and be a member of the project. Other people can't see the issue.


Troubleshooting

Problem

Possible cause

Solution

The link opens an error page.

The project ID or issue GUID is wrong, or the parts are in the wrong place.

Check the IDs and the link format.

The link opens, but the issue isn't shown.

The user isn't a member of the project.

Ask the project leader to add the user to the project.

The link opens the wrong space.

The space URL is wrong.

Use the URL of the space that contains the project.


Related articles

Did this answer your question?