    

 ## On this page

  

 

 # SherlockCommonService

 Last update: 09.03.2026 

Copyright 2023-2024 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited.

## ExitRequest

Request to exit the gRPC connection.

FieldTypeLabelDescriptioncloseSherlockClient[bool](#bool)If set to true, exits the Sherlock client if it is opened. Otherwise, just closes the gRPC connection.## GetSoldersRequest

Request for a list of valid solder materials.

## GetSoldersResponse

Represents a list of valid solder materials.

FieldTypeLabelDescriptionsolderName[string](#string)repeatedList of valid solder materials.## HealthCheckRequest

Request to check if the gRPC connection is open.

## HealthCheckResponse

Represents whether the gRPC connection is open.

FieldTypeLabelDescriptionstatus[HealthCheckResponse.ServingStatus](#healthcheckresponse.servingstatus)Enum representing connection status.port[int32](#int32)Listening port number on server.## IsSherlockClientLoadingRequest

Check if the Sherlock client is still loading.

## ListUnitsRequest

Request for a list of valid units of the provided unit type.

FieldTypeLabelDescriptionunitType[ListUnitsRequest.UnitType](#listunitsrequest.unittype)Unit type to request valid units of.## ListUnitsResponse

Represents a list of valid units for the provided unit type.

FieldTypeLabelDescriptionreturnCode[ReturnCode](#returncode)Status code of response.units[string](#string)repeatedList of valid units for the requested type.## Measurement

Represents a common measurement with a value and a unit

FieldTypeLabelDescriptionvalue[double](#double)Numerical value of a measurement.units[string](#string)Units of the numerical value.## ReturnCode

Status response of a message. A value of 0 indicates a successful request.

FieldTypeLabelDescriptionvalue[int32](#int32)Status code of response. A value of 0 indicates success, -1 indicates error.message[string](#string)Message indicating the status of response including any error.## SherlockInfoRequest

Request to receive Sherlock version and configuration data.

## SherlockInfoResponse

Represents Sherlock version and configuration data.

FieldTypeLabelDescriptionreleaseVersion[string](#string)The current version of Sherlock, formatted as: YYYY R# (Ex. "2025 R2")defaultProjectDir[string](#string)The project directory currently used by Sherlock.isSingleProjectMode[bool](#bool)When true, indicates that Sherlock is in single-project mode. When false, indicates that Sherlock is in multi-project mode.## ServingStatus

NameNumberDescriptionUNKNOWN0Indicates an unknown connection status.SERVING1Indicates the connection is up and server is listening.NOT\_SERVING2Indicates connection with server is closed.## UnitType

NameNumberDescriptionUNKNOWN0Indicates an unknown unit type.ACCEL\_DENSITY1Units used for acceleration density.ACCELERATION2Units used for acceleration.AREA3Units used for area.BANDWIDTH4Units used for bandwidth.CAPACITANCE5Units used for electrical capacitance.CTE6Units used for material CTE.CURRENT7Units used for electrical current.DENSITY8Units used for density.DISP\_DENSITY9Units used for displacement density.FORCE10Units used for force.FREQUENCY11Units used for frequency.INDUCTANCE12Units used for inductance.LENGTH13Units used for length.POWER14Units used for electrical power.RESISTANCE15Units used for electrical resistance.SIZE16Units used for size.SPECIFIC\_HEAT17Units used for specific heat.STRAIN18Units used for strain.STRESS19Units used for stress.TEMPERATURE20Units used for temperature.THERMAL\_CONDUCTIVITY21Units used for thermal conductivity.THERMAL\_RESISTANCE22Units used for thermal resistance.TIME23Units used for time.VELOCITY24Units used for velocity.VELOCITY\_DENSITY25Units used for velocity density.VOLTAGE26Units used for electrical voltage.VOLUME27Units used for volume.WEIGHT28Units used for weight.## MatchingMode

Determines how parts in the parts list are matched against parts in the AVL or Part Library.

NameNumberDescriptionBoth0Matches both part number and manufacturer.Part1Matches part number only.## TableDelimiter

Types of delimiters that can be used for exporting tables

NameNumberDescriptionCOMMA0Represents ',' delimiter.SPACE1Represents ' ' delimiter.TAB2Represents tab key delimiter.SEMICOLON3Represents ';' delimiter.## SherlockCommonService

Method NameRequest TypeResponse TypeDescriptioncheck[.HealthCheckRequest](#healthcheckrequest)[.HealthCheckResponse](#healthcheckresponse)Returns health status of gRPC server.exit[.ExitRequest](#exitrequest)[.ReturnCode](#returncode)Signals for gRPC connection to shutdown.isSherlockClientLoading[.IsSherlockClientLoadingRequest](#issherlockclientloadingrequest)[.ReturnCode](#returncode)Check if the Sherlock client is still loading.listUnits[.ListUnitsRequest](#listunitsrequest)[.ListUnitsResponse](#listunitsresponse)Returns a list of valid units of the provided unit type.getSolders[.GetSoldersRequest](#getsoldersrequest)[.GetSoldersResponse](#getsoldersresponse)Returns a list of valid solder materials.getSherlockInfo[.SherlockInfoRequest](#sherlockinforequest)[.SherlockInfoResponse](#sherlockinforesponse)Returns meta data about Sherlock.Back to [Top](#table-of-contents)