zen_api/lm/slide_scan/v1/slide_scan_service.proto#
Version: 2026.5.1
Package: zen_api.lm.slide_scan.v1
Service SlideScanService#
The ISlideScanService interface.
GetChannelSettings#
Gets a list of configured channel settings of a scan profile.
rpc GetChannelSettings (zen_api.lm.slide_scan.v1.SlideScanServiceGetChannelSettingsRequest) returns (zen_api.lm.slide_scan.v1.SlideScanServiceGetChannelSettingsResponse);
Request: zen_api.lm.slide_scan.v1.SlideScanServiceGetChannelSettingsRequest
Response: zen_api.lm.slide_scan.v1.SlideScanServiceGetChannelSettingsResponse
GetMagazineState#
Gets the magazine state.
rpc GetMagazineState (zen_api.lm.slide_scan.v1.SlideScanServiceGetMagazineStateRequest) returns (zen_api.lm.slide_scan.v1.SlideScanServiceGetMagazineStateResponse);
Request: zen_api.lm.slide_scan.v1.SlideScanServiceGetMagazineStateRequest
Response: zen_api.lm.slide_scan.v1.SlideScanServiceGetMagazineStateResponse
GetStorageFolder#
Gets the current storage folder for images.
rpc GetStorageFolder (zen_api.lm.slide_scan.v1.SlideScanServiceGetStorageFolderRequest) returns (zen_api.lm.slide_scan.v1.SlideScanServiceGetStorageFolderResponse);
Request: zen_api.lm.slide_scan.v1.SlideScanServiceGetStorageFolderRequest
Response: zen_api.lm.slide_scan.v1.SlideScanServiceGetStorageFolderResponse
Observe#
Monitors anything that happens within ZEN or the microscope. The main purpose is to observe the scan profile acquisition progress.
rpc Observe (zen_api.lm.slide_scan.v1.SlideScanServiceObserveRequest) returns (stream zen_api.lm.slide_scan.v1.SlideScanServiceObserveResponse);
Request: zen_api.lm.slide_scan.v1.SlideScanServiceObserveRequest
Response: zen_api.lm.slide_scan.v1.SlideScanServiceObserveResponse
ResetSlideStates#
Resets the specified slides to new.
rpc ResetSlideStates (zen_api.lm.slide_scan.v1.SlideScanServiceResetSlideStatesRequest) returns (zen_api.lm.slide_scan.v1.SlideScanServiceResetSlideStatesResponse);
Request: zen_api.lm.slide_scan.v1.SlideScanServiceResetSlideStatesRequest
Response: zen_api.lm.slide_scan.v1.SlideScanServiceResetSlideStatesResponse
SetStorageFolder#
Sets the storage folder for images.
rpc SetStorageFolder (zen_api.lm.slide_scan.v1.SlideScanServiceSetStorageFolderRequest) returns (zen_api.lm.slide_scan.v1.SlideScanServiceSetStorageFolderResponse);
Request: zen_api.lm.slide_scan.v1.SlideScanServiceSetStorageFolderRequest
Response: zen_api.lm.slide_scan.v1.SlideScanServiceSetStorageFolderResponse
StartScanPreview#
Starts the preview with the specified input.
rpc StartScanPreview (zen_api.lm.slide_scan.v1.SlideScanServiceStartScanPreviewRequest) returns (zen_api.lm.slide_scan.v1.SlideScanServiceStartScanPreviewResponse);
Request: zen_api.lm.slide_scan.v1.SlideScanServiceStartScanPreviewRequest
Response: zen_api.lm.slide_scan.v1.SlideScanServiceStartScanPreviewResponse
StartScanProfile#
Starts the scan profile with the specified input.
rpc StartScanProfile (zen_api.lm.slide_scan.v1.SlideScanServiceStartScanProfileRequest) returns (zen_api.lm.slide_scan.v1.SlideScanServiceStartScanProfileResponse);
Request: zen_api.lm.slide_scan.v1.SlideScanServiceStartScanProfileRequest
Response: zen_api.lm.slide_scan.v1.SlideScanServiceStartScanProfileResponse
StopScanPreview#
Stops the preview execution.
rpc StopScanPreview (zen_api.lm.slide_scan.v1.SlideScanServiceStopScanPreviewRequest) returns (zen_api.lm.slide_scan.v1.SlideScanServiceStopScanPreviewResponse);
Request: zen_api.lm.slide_scan.v1.SlideScanServiceStopScanPreviewRequest
Response: zen_api.lm.slide_scan.v1.SlideScanServiceStopScanPreviewResponse
StopScanProfile#
Stops the scan profile execution.
rpc StopScanProfile (zen_api.lm.slide_scan.v1.SlideScanServiceStopScanProfileRequest) returns (zen_api.lm.slide_scan.v1.SlideScanServiceStopScanProfileResponse);
Request: zen_api.lm.slide_scan.v1.SlideScanServiceStopScanProfileRequest
Response: zen_api.lm.slide_scan.v1.SlideScanServiceStopScanProfileResponse
UnmarkSlides#
Unmark the specified slides. In the case of empty slide list, unmark all slides. If in the list of slides to be unselected, a slide is currently being previewed or scanned, the command is denied with an error message explaining the reason.
rpc UnmarkSlides (zen_api.lm.slide_scan.v1.SlideScanServiceUnmarkSlidesRequest) returns (zen_api.lm.slide_scan.v1.SlideScanServiceUnmarkSlidesResponse);
Request: zen_api.lm.slide_scan.v1.SlideScanServiceUnmarkSlidesRequest
Response: zen_api.lm.slide_scan.v1.SlideScanServiceUnmarkSlidesResponse
Message GeneralResponse#
A general response for all asynchronous requests that do not return any results or data.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
type |
1 | zen_api.lm.slide_scan.v1.ResponseType | singular | The type of resonse message. |
code |
2 | zen_api.lm.slide_scan.v1.ResponseCode | singular | The code of resonse message. |
description |
3 | string |
singular | A description. Explanation text, for developers only. |
user_message |
4 | string |
singular | A message suitable to be shown in user interfaces, will be translated by Api. |
Message SlideScanServiceGetChannelSettingsRequest#
Describes the input parameters for retrieving the configured channels.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
scan_profile_path |
1 | string |
singular | The path of the specified scan profile. |
Message SlideScanServiceGetChannelSettingsResponse#
Lists the configured channel settings in the specified scan profile.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
channel_setting_list |
1 | zen_api.lm.slide_scan.v1.ChannelSettings | repeated | The configured channel settings. |
Message SlideScanServiceGetMagazineStateRequest#
Describes the input parameters for a call to retrieve the magazine state.
Message SlideScanServiceGetMagazineStateResponse#
Lists the populated slides of each tray.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
trays |
1 | zen_api.lm.slide_scan.v1.TrayInformation | repeated | The loaded slides per tray. |
Message SlideScanServiceGetStorageFolderRequest#
Describes the input parameters for a call to retrieve the storage folder for slide scans.
Message SlideScanServiceGetStorageFolderResponse#
Describes the result for a call to retrieve the storage folder for slide scans.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
path |
1 | string |
singular | The storage folder path. |
Message SlideScanServiceObserveRequest#
Describes the input parameters for a call to observe the events and progress that happen either during acquisition or while the microscope is idling.
Message SlideScanServiceObserveResponse#
Describes the output parameters for a call to observe the events, progress and additional information like warnings and errors of a running scan profile acquisition. The response might be a stream of different information types (e.g. Progress, Error, Hardware State, ...).
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
information |
1 | zen_api.lm.slide_scan.v1.InformationBase | singular | The flexible, variable information. |
Message SlideScanServiceResetSlideStatesRequest#
Describes the input parameters for resetting the state of specified slides to new.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
slide_position_list |
1 | zen_api.lm.slide_scan.v1.SlidePositionInformation | repeated | The position of the slide list to be reset. |
Message SlideScanServiceResetSlideStatesResponse#
Describes the output parameters for resetting the state of specified slides.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
response |
1 | zen_api.lm.slide_scan.v1.GeneralResponse | singular | A general response about the success/error state of the request. |
Message SlideScanServiceSetStorageFolderRequest#
Describes the input parameters for setting the storage folder for slide scans.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
path |
1 | string |
singular | The path to the storage folder where slide scans should be stored. |
Message SlideScanServiceSetStorageFolderResponse#
Describes the result for a call to set the storage folder.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
response |
1 | zen_api.lm.slide_scan.v1.GeneralResponse | singular | A general response to inform about the requests success/error state. |
Message SlideScanServiceStartScanPreviewRequest#
Describes the input parameters for the preview start.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
scan_profile_name |
1 | string |
singular | The name of the scan profile that should be started. |
slide_position_list |
2 | zen_api.lm.slide_scan.v1.SlidePositionInformation | repeated | The list of tray/slides to be processed. |
scan_profile_options_override |
3 | zen_api.lm.slide_scan.v1.ScanProfileOptionsOverride | singular | Optional overrides for scan profile options. |
Message SlideScanServiceStartScanPreviewResponse#
Response of starting a preview in the slide scan service.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
response |
1 | zen_api.lm.slide_scan.v1.GeneralResponse | singular | A general response to inform about the requests success/error state. |
Message SlideScanServiceStartScanProfileRequest#
Describes the input parameters for the scan profile start.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
scan_profile_name |
1 | string |
singular | The name of the scan profile that should be started. |
slide_position_list |
2 | zen_api.lm.slide_scan.v1.SlidePositionInformation | repeated | The list of tray/slides to be processed. |
channel_settings |
3 | zen_api.lm.slide_scan.v1.ChannelSettings | repeated | The list of changed channel settings. |
region_definitions |
4 | zen_api.lm.slide_scan.v1.RegionDefinition | repeated | The list of region contour definition. |
scan_profile_options_override |
5 | zen_api.lm.slide_scan.v1.ScanProfileOptionsOverride | singular | Optional overrides for scan profile options. |
Message SlideScanServiceStartScanProfileResponse#
Describes the output parameters for a call to start the scan profile.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
response |
1 | zen_api.lm.slide_scan.v1.GeneralResponse | singular | A general response to inform about the requests success/error state. |
Message SlideScanServiceStopScanPreviewRequest#
Represents a request to stop the preview in the SlideScan service.
Message SlideScanServiceStopScanPreviewResponse#
Represents the response for stopping the preview in the slide scan service.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
response |
1 | zen_api.lm.slide_scan.v1.GeneralResponse | singular | A general response to inform about the requests success/error state. |
Message SlideScanServiceStopScanProfileRequest#
Describes the input parameters for stopping the scan profile.
Message SlideScanServiceStopScanProfileResponse#
Describes the output parameters for a call to stop the scan profile.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
response |
1 | zen_api.lm.slide_scan.v1.GeneralResponse | singular | A general response to inform about the requests success/error state. |
Message SlideScanServiceUnmarkSlidesRequest#
Describes the input parameters for unmark slides.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
slide_position_list |
1 | zen_api.lm.slide_scan.v1.SlidePositionInformation | repeated | The position of the slide list to be unmarked. |
Message SlideScanServiceUnmarkSlidesResponse#
Describes the output parameters for a call to unmark slides.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
response |
1 | zen_api.lm.slide_scan.v1.GeneralResponse | singular | A general response to inform about the requests success/error state. |