User Tools

Site Tools


nonapi

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
nonapi [2023/08/04 08:32] – [Region] angelosnonapi [2023/11/27 16:35] (current) – chris
Line 1: Line 1:
 ===== Image Endpoints ===== ===== Image Endpoints =====
  
-The following endpoints are available in PMA.core to view Whole Slide Images and its associated labels, thumbnails and macro images. The following list contains the endpoint URL, a brief description and the available parameters for each one.+The following endpoints are available in PMA.core to view Whole Slide Images and their associated labels, thumbnails and macro images. The following list contains the endpoint URL, a brief description and the available parameters for each one.
  
 ==== Tile ==== ==== Tile ====
Line 30: Line 30:
 **/region** Renders a region of a slide **/region** Renders a region of a slide
 ^Parameter ^Description^ ^Parameter ^Description^
-|**sessionID**|The session id to authenticate with|+|**sessionID**|The session ID to authenticate with|
 |**pathOrUid**|The path or unique identifier of the image to render| |**pathOrUid**|The path or unique identifier of the image to render|
 |**timeframe**|The index of the time frame to render| |**timeframe**|The index of the time frame to render|
Line 60: Line 60:
 **Example** ///region?sessionId=%%sessionId%%&pathOrUid=%%path%%&timeframe=0&layer=0&channels=0&channelClipping=0,0&channelColor=ffffffff&gamma=1&x=0&y=0&width=1000&height=1000&scale=0.1// **Example** ///region?sessionId=%%sessionId%%&pathOrUid=%%path%%&timeframe=0&layer=0&channels=0&channelClipping=0,0&channelColor=ffffffff&gamma=1&x=0&y=0&width=1000&height=1000&scale=0.1//
  
-In the example request above, the system will render a portion of 1000x1000 pixels of the full resolution image and scale it to 100x100 pixels before it returns it to the client.+In the example request above, the system will render a 1000x1000 pixel portion of the full resolution image and scale it to 100x100 pixels before it returns it to the client.
 ==== Thumbnail ==== ==== Thumbnail ====
 **/thumbnail** Renders the associated thumbnail of slide **/thumbnail** Renders the associated thumbnail of slide
 ^Parameter ^Description^ ^Parameter ^Description^
-|**sessionID**|The session id to authenticate with|+|**sessionID**|The session ID to authenticate with|
 |**pathOrUid**|The path or unique identifier of the image to render| |**pathOrUid**|The path or unique identifier of the image to render|
 |orientation|//Optional// The orientation of the thumbnail (0 = auto; 1 = vertical; 2 = horizontal)| |orientation|//Optional// The orientation of the thumbnail (0 = auto; 1 = vertical; 2 = horizontal)|
Line 78: Line 78:
  
 ^Parameter ^Description^ ^Parameter ^Description^
-|**sessionID**|The session id to authenticate with|+|**sessionID**|The session ID to authenticate with|
 |**pathOrUid**|The path or unique identifier of the image to render| |**pathOrUid**|The path or unique identifier of the image to render|
 |orientation|//Optional// The orientation of the macro (0 = auto; 1 = vertical; 2 = horizontal)| |orientation|//Optional// The orientation of the macro (0 = auto; 1 = vertical; 2 = horizontal)|
Line 90: Line 90:
 **/barcode** Renders the associated [[barcode|barcode]] of a slide **/barcode** Renders the associated [[barcode|barcode]] of a slide
 ^Parameter ^Description^ ^Parameter ^Description^
-|**sessionID**|The session id to authenticate with|+|**sessionID**|The session ID to authenticate with|
 |**pathOrUid**|The path or unique identifier of the image to render| |**pathOrUid**|The path or unique identifier of the image to render|
 |orientation|//Optional// The orientation of the barcode (0 = auto; 1 = vertical; 2 = horizontal)| |orientation|//Optional// The orientation of the barcode (0 = auto; 1 = vertical; 2 = horizontal)|
nonapi.1691130772.txt.gz · Last modified: by angelos

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki