nonapi
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
nonapi [2022/07/28 12:11] angelos |
nonapi [2022/07/28 13:00] (current) yves [Macro] |
||
|---|---|---|---|
| Line 3: | Line 3: | ||
| 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 its 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 ==== |
| **/tile** Renders a square tile of a slide | **/tile** Renders a square tile 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 or a valid collection config JSON| | |pathOrUid|The path or unique identifier of the image to render or a valid collection config JSON| | ||
| Line 24: | Line 24: | ||
| **Returns** A file stream that contains the rendered region | **Returns** A file stream that contains the rendered region | ||
| - | === Region === | + | ==== Region ==== |
| **/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| | ||
| Line 48: | Line 48: | ||
| |flipHorizontal|Whether to flip region horizontally| | |flipHorizontal|Whether to flip region horizontally| | ||
| |flipVertical|Whether to flip the region vertically| | |flipVertical|Whether to flip the region vertically| | ||
| - | |dpi|Optional dpi to resolution for the exported image| | + | |dpi|//Optional// dpi to resolution for the exported image| |
| - | |postGamma|Optional gamma value to apply as post processing| | + | |postGamma|//Optional// gamma value to apply as post processing| |
| - | |brightness|Optional brightness value to apply as post processing| | + | |brightness|//Optional// brightness value to apply as post processing| |
| - | |contrast|Optional contrast value to apply as post processing| | + | |contrast|//Optional// contrast value to apply as post processing| |
| **Returns** A file stream that contains the rendered region | **Returns** A file stream that contains the rendered region | ||
| - | === 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| | ||
| Line 64: | Line 64: | ||
| **Returns** An image | **Returns** An image | ||
| - | === Macro === | + | ==== Macro ==== |
| **/macro** Renders the associated macro of a slide | **/macro** Renders the associated macro 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| | ||
| Line 75: | Line 75: | ||
| **Returns** An image | **Returns** An image | ||
| - | === Barcode === | + | ==== Barcode ==== |
| **/barcode** Renders the associated barcode of a slide | **/barcode** Renders the associated 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|The orientation of the barcode(0 = auto; 1 = vertical; 2 = horizontal)| | + | |orientation|The orientation of the barcode (0 = auto; 1 = vertical; 2 = horizontal)| |
| |w|Expected output width of the barcode| | |w|Expected output width of the barcode| | ||
| |h|Expected output height of the barcode| | |h|Expected output height of the barcode| | ||
| **Returns** An image | **Returns** An image | ||
nonapi.1658999461.txt.gz · Last modified: 2022/07/28 12:11 by angelos
