Navigating to an Annotation via URL
Overview
Sometimes there is a need to help the user to navigate directly to a particular annotation from an external system (for example for a review and maybe a correction).
For this purpose a specially crafted URL will allow navigation directly to an expected annotation set, or annotation.
Notes
- The user must have permissions to access the project and the specified annotation set (otherwise the link will not show the slide and object of interest)
- If the user is not logged in to the portal when accessing the URL, they will first be redirected to the login page for authentication, and then taken to the URL after successful login
- If an annotation_set_id is specified, that annotation set will be loaded and selected in the annotation panel
- If an annotation_id is specified, that annotation will be automatically selected in the annotation panel
- If no bounding box is specified, an appropriate zoom level will be chosen to fully display the specified annotation (fit to view)
Examples
- A system or a script generating a log with URLs of annotations for a review
- A report of analysis that includes URLs for annotations for traceability or source data (to give a user a possibility to help with "Which exactly annotation was used to produce a particular score?")
URL Format and examples
To navigate to an annotation or annotation set, the following URL parameters are used:
| Project ID | Slide ID | Annotation Set ID | Annotation ID | Bounding Box | |
|---|---|---|---|---|---|
| Parameter in URL | (part of path) | (part of path) | annotation_set_id | annotation_id | bbox |
| Example value in URL | 5ebd...1111 | 5efa...2222 | annotation_set_id=5ef...ce9 | annotation_id=613...f34 | x1,y1,x2,y2 e.g.: bbox= 1%2C2%2C3%2C4 |
| Operation: Navigate to an annotation set e.g. Set 6789 |
optional | ||||
| Operation: Navigate to a specified region within an annotation set e.g. Region 500-200-550-300 of set 6789 |
|||||
| Operation: Navigate to a specified annotation e.g. Sets 6789 and 9876 |
optional | ||||
| Operation: Navigate to a specified region within an annotation e.g. Region 500-200-550-300 of sets 9876 and 6789 |