    

 ## On this page

  

 

 # SherlockAnalysisService

 Last update: 09.03.2026 

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

## GetHarmonicVibeInputFieldsRequest

Request to list the valid Harmonic Vibe input fields for the provided model source and user configuration.

FieldTypeLabelDescriptionmodelSource[ModelSource](#modelsource)optionalOptional model source. Default: GENERATED.## GetHarmonicVibeInputFieldsResponse

FieldTypeLabelDescriptionfieldName[string](#string)repeatedList of Harmonic Vibe input fields.## GetICTAnalysisInputFieldsRequest

Request to list the valid ICT analysis input fields given the user configuration.

## GetICTAnalysisInputFieldsResponse

FieldTypeLabelDescriptionfieldName[string](#string)repeatedList of ICT Analysis input fields.## GetMechanicalShockInputFieldsRequest

Request to list the valid mechanical shock input fields for the provided model source and user configuration.

FieldTypeLabelDescriptionmodelSource[ModelSource](#modelsource)optionalOptional model source. Default: GENERATED.## GetMechanicalShockInputFieldsResponse

FieldTypeLabelDescriptionfieldName[string](#string)repeatedList of Mechanical Shock input fields for a model source.## GetNaturalFrequencyInputFieldsRequest

Request to list the valid natural frequency input fields given the user configuration.

## GetNaturalFrequencyInputFieldsResponse

FieldTypeLabelDescriptionfieldName[string](#string)repeatedList of Natural Frequency input fields.## GetPartsListValidationPropsRequest

Request to retrieve the Parts List Validation properties.

FieldTypeLabelDescriptionproject[string](#string)Sherlock Project name.ccaName[string](#string)The CCA name.## GetPcbModelingInputFieldsRequest

Request to list the valid PCB Modeling input fields given the user configuration.

## GetPcbModelingInputFieldsResponse

FieldTypeLabelDescriptionfieldName[string](#string)repeatedList of Pcb Modeling input fields.## GetRandomVibeInputFieldsRequest

Request to list the valid random vibe input fields for the provided model source and user configuration.

FieldTypeLabelDescriptionmodelSource[ModelSource](#modelsource)optionalOptional model source. Default: GENERATED.## GetRandomVibeInputFieldsResponse

FieldTypeLabelDescriptionfieldName[string](#string)repeatedList of Random Vibe input fields.## GetSolderFatigueInputFieldsRequest

Request to list the valid solder fatigue input fields given the user configuration.

## GetSolderFatigueInputFieldsResponse

FieldTypeLabelDescriptionfieldName[string](#string)repeatedList of Solder Fatigue input fields.## PartsListValidationPropsResponse

Response that includes Parts List Validation properties.

FieldTypeLabelDescriptionreturnCode[ReturnCode](#returncode)Status code of response.partLibrary[string](#string)Part library name.processUseAVL[bool](#bool)Process option to use AVL.processUseWizard[bool](#bool)Process option to use wizard.processCheckConfirmedProperties[bool](#bool)Process option to check confirmed properties.processCheckPartNumbers[bool](#bool)Process option to check part numbers.matching[MatchingMode](#matchingmode)Matching type.avlRequireInternalPartNumber[bool](#bool)AVL option to require internal part number.avlRequireApprovedDescription[bool](#bool)AVL option to require approved description.avlRequireApprovedManufacturer[bool](#bool)AVL option to require approved manufacturer.## RunAnalysisRequest

Request to run one or more Sherlock analysis given the project path, CCA name, analyses, lifecycle phases and events.

FieldTypeLabelDescriptionproject[string](#string)Sherlock project name.ccaName[string](#string)The CCA name.analyses[RunAnalysisRequest.Analysis](#runanalysisrequest.analysis)repeatedList of Analyses to run.## RunAnalysisRequest.Analysis

FieldTypeLabelDescriptiontype[RunAnalysisRequest.Analysis.AnalysisType](#runanalysisrequest.analysis.analysistype)Type of Analysis to run.phases[RunAnalysisRequest.Analysis.Phase](#runanalysisrequest.analysis.phase)repeatedList of Phases for each Analysis to run.## RunAnalysisRequest.Analysis.Phase

FieldTypeLabelDescriptionname[string](#string)Life cycle phase name.events[RunAnalysisRequest.Analysis.Phase.Event](#runanalysisrequest.analysis.phase.event)repeatedList of life cycle Events.## RunAnalysisRequest.Analysis.Phase.Event

FieldTypeLabelDescriptionname[string](#string)Life cycle event name.## RunStrainMapAnalysisRequest

Request to run Sherlock strain map analysis given the project name, CCA name, and strain maps.

FieldTypeLabelDescriptionproject[string](#string)Sherlock project name.ccaName[string](#string)The CCA name of the main CCA for the analysis.strainMapAnalyses[RunStrainMapAnalysisRequest.StrainMapAnalysis](#runstrainmapanalysisrequest.strainmapanalysis)repeatedList of Strain Map Analyses to run.## RunStrainMapAnalysisRequest.StrainMapAnalysis

FieldTypeLabelDescriptiontype[RunStrainMapAnalysisRequest.StrainMapAnalysis.AnalysisType](#runstrainmapanalysisrequest.strainmapanalysis.analysistype)Type of Strain Map analysis to run.eventStrainMaps[RunStrainMapAnalysisRequest.StrainMapAnalysis.EventStrainMap](#runstrainmapanalysisrequest.strainmapanalysis.eventstrainmap)repeatedList of Strain Map events to run.## RunStrainMapAnalysisRequest.StrainMapAnalysis.EventStrainMap

FieldTypeLabelDescriptionphaseName[string](#string)Life cycle phase name.eventName[string](#string)Life cycle event name.pcbSide[string](#string)PCB side for the strain map. Supported values are: TOP, BOTTOM.strainMap[string](#string)Strain map assigned to the event.subAssemblyName[string](#string)optionalThe name of the sub-assembly CCA to be assigned the strain map.## UpdateHarmonicVibePropsRequest

Request to update the harmonic vibe analysis properties for one or more CCA's in the project indicated.

FieldTypeLabelDescriptionproject[string](#string)Project name.harmonicVibeProperties[UpdateHarmonicVibePropsRequest.HarmonicVibe](#updateharmonicvibepropsrequest.harmonicvibe)repeatedList of HarmonicVibe analysis properties to update.## UpdateHarmonicVibePropsRequest.HarmonicVibe

FieldTypeLabelDescriptionccaName[string](#string)CCA name for which the harmonic vibe properties are set.modelSource[ModelSource](#modelsource)optionalOptional model source. Default: GENERATED.harmonicVibeCount[int32](#int32)optionalNumber of harmonic result layers to generate.harmonicVibeDamping[string](#string)optionalModal Damping Ratio(s).partValidationEnabled[bool](#bool)optionalFlag indicating if part validation should be performed.requireMaterialAssignmentEnabled[bool](#bool)optionalFlag indicating if material assignment is required.analysisTemp[double](#double)optionalTemperature.analysisTempUnits[string](#string)optionalTemperature units.forceModelRebuild[string](#string)optionalModel Creation. Valid values are "FORCE" or "AUTO".filterByEventFrequency[bool](#bool)optionalFlag indicating if harmonic results outside selected event range are imported.naturalFreqMin[uint32](#uint32)optionalMin Frequency. For NX Nastran analysis only.naturalFreqMinUnits[string](#string)optionalMin Frequency units. For NX Nastran analysis only.naturalFreqMax[uint32](#uint32)optionalMax Frequency. For NX Nastran analysis only.naturalFreqMaxUnits[string](#string)optionalMax Frequency units. For NX Nastran analysis only.reuseModalAnalysis[bool](#bool)optionalReuse Natural Frequency. For NX Nastran analysis only.strainMapNaturalFreq[double](#double)optionalMaximum Natural Frequency used for strain map analysis.## UpdateICTAnalysisPropsRequest

Request to update ICT Analysis properties.

FieldTypeLabelDescriptionproject[string](#string)Sherlock Project name.ictAnalysisProperties[UpdateICTAnalysisPropsRequest.ICTAnalysis](#updateictanalysispropsrequest.ictanalysis)repeatedList of ICTAnalysis properties to update for each CCA in a project.## UpdateICTAnalysisPropsRequest.ICTAnalysis

FieldTypeLabelDescriptionccaName[string](#string)The CCA name.applicationTime[double](#double)optionalApplication Time.applicationTimeUnits[string](#string)optionalApplication Time Units.numberOfEvents[uint32](#uint32)optionalNumber of Events.partValidationEnabled[bool](#bool)optionalPart Validation.requireMaterialAssignmentEnabled[bool](#bool)optionalFlag indicating if material assignment is required.forceModelRebuild[string](#string)optionalModel Creation. Valid values are "FORCE" or "AUTO".ictResultCount[int32](#int32)optionalNumber of ICT layers to generate when using thermal analysis.## UpdateMechanicalShockPropsRequest

Request to update the mechanical shock analysis properties.

FieldTypeLabelDescriptionproject[string](#string)Sherlock Project name.mechanicalShockProperties[UpdateMechanicalShockPropsRequest.MechanicalShock](#updatemechanicalshockpropsrequest.mechanicalshock)repeatedList of MechanicalShock properties to update.## UpdateMechanicalShockPropsRequest.MechanicalShock

FieldTypeLabelDescriptionccaName[string](#string)The CCA name.modelSource[ModelSource](#modelsource)optionalDefault is GENERATED.shockResultCount[int32](#int32)optionalMechanical Shock Result Count.criticalShockStrain[double](#double)optionalCritical Shock Strain.criticalShockStrainUnits[string](#string)optionalCritical Shock Strain units.partValidationEnabled[bool](#bool)optionalFlag indicating if part validation should be performed.requireMaterialAssignmentEnabled[bool](#bool)optionalFlag indicating if material assignment is required.forceModelRebuild[string](#string)optionalModel Creation. Valid values are "FORCE" or "AUTO".naturalFreqMin[uint32](#uint32)optionalMin Frequency.naturalFreqMinUnits[string](#string)optionalMin Frequency units.naturalFreqMax[uint32](#uint32)optionalMax Frequency.naturalFreqMaxUnits[string](#string)optionalMax Frequency units.analysisTemp[double](#double)optionalTemperature.analysisTempUnits[string](#string)optionalTemperature units.## UpdateNaturalFrequencyPropsRequest

Request to update natural frequency analysis properties.

FieldTypeLabelDescriptionproject[string](#string)Project name.ccaName[string](#string)CCA name.naturalFreqCount[int32](#int32)NF Result Count.naturalFreqMin[double](#double)Min Frequency. IMPORTANT: Only Integer values will be accepted for this field. Decimal values will be rejected in the API.naturalFreqMinUnits[string](#string)Min Frequency units (HZ, KHZ, MHZ, or GHZ).naturalFreqMax[double](#double)Max Frequency. IMPORTANT: Only Integer values will be accepted for this field. Decimal values will be rejected in the API.naturalFreqMaxUnits[string](#string)Max Frequency units (HZ, KHZ, MHZ, or GHZ).partValidationEnabled[bool](#bool)Part Validation.requireMaterialAssignmentEnabled[bool](#bool)Require Material Assignment.analysisTemp[double](#double)optionalTemperature.analysisTempUnits[string](#string)optionalTemperature units (C, F, or K).## UpdatePartModelingRequest

Request to update FEA part modeling properties.

FieldTypeLabelDescriptionproject[string](#string)Sherlock project name.ccaName[string](#string)The CCA name.partEnabled[bool](#bool)Whether to enable part modeling. Ignores all other fields if part modeling is disabled.partMinSize[double](#double)optionalThe minimum part size.partMinSizeUnits[string](#string)optionalUnits for minimum part size.partElemOrder[string](#string)optionalElement order.partMaxEdgeLength[double](#double)optionalMaximum mesh size.partMaxEdgeLengthUnits[string](#string)optionalUnits for maximum mesh size.partMaxVertical[double](#double)optionalVertical mesh size.partMaxVerticalUnits[string](#string)optionalUnits for vertical mesh size.partResultsFiltered[bool](#bool)optionalWhether to enable filtered part results.## UpdatePartsListValidationPropsRequest

Request to update the Parts List Validation properties.

FieldTypeLabelDescriptionproject[string](#string)Sherlock Project name.partsListValidationProperties[UpdatePartsListValidationPropsRequest.PartsListValidation](#updatepartslistvalidationpropsrequest.partslistvalidation)repeatedProperties for each CCA in the project.## UpdatePartsListValidationPropsRequest.PartsListValidation

FieldTypeLabelDescriptionccaName[string](#string)The CCA name.partLibrary[string](#string)optionalPart library name.processUseAVL[bool](#bool)optionalProcess option to use AVL.processUseWizard[bool](#bool)optionalProcess option to use wizard.processCheckConfirmedProperties[bool](#bool)optionalProcess option to check confirmed properties.processCheckPartNumbers[bool](#bool)optionalProcess option to check part numbers.matching[MatchingMode](#matchingmode)optionalMatching type.avlRequireInternalPartNumber[bool](#bool)optionalAVL require internal part number.avlRequireApprovedDescription[bool](#bool)optionalAVL require approved description.avlRequireApprovedManufacturer[bool](#bool)optionalAVL require approved manufacturer.## UpdatePcbModelingPropsRequest

Request to update FEA analysis PCB Modeling properties.

FieldTypeLabelDescriptionproject[string](#string)Sherlock project name.ccaNames[string](#string)repeatedThe CCA names for which to assign the PCB modeling parameters.analyses[UpdatePcbModelingPropsRequest.Analysis](#updatepcbmodelingpropsrequest.analysis)repeatedList of Analysis message types.## UpdatePcbModelingPropsRequest.Analysis

FieldTypeLabelDescriptiontype[UpdatePcbModelingPropsRequest.Analysis.AnalysisType](#updatepcbmodelingpropsrequest.analysis.analysistype)The type of analysis for which PCB modeling properties apply.modelType[UpdatePcbModelingPropsRequest.Analysis.PcbModelType](#updatepcbmodelingpropsrequest.analysis.pcbmodeltype)The PCB modeling mesh type.modelingRegionEnabled[bool](#bool)Indicates if modeling regions are enabled.pcbMaterialModel[UpdatePcbModelingPropsRequest.Analysis.PcbMaterialModel](#updatepcbmodelingpropsrequest.analysis.pcbmaterialmodel)The PCB modeling PCB model type.pcbMaxMaterials[int32](#int32)optionalThe number of PCB materials for Uniform Elements and Layered Elements PCB model types.pcbElemOrder[ElementOrder](#elementorder)The element order for PCB elements.pcbMaxEdgeLength[double](#double)The maximum mesh size for PCB elements.pcbMaxEdgeLengthUnits[string](#string)The length units for the maximum mesh size.pcbMaxVertical[double](#double)The maximum vertical mesh size for PCB elements.pcbMaxVerticalUnits[string](#string)The length units for the maximum vertical mesh size.quadsPreferred[bool](#bool)Indicates that the meshing engine should attempt to generate quad-shaped elements when creating the mesh.## UpdateRandomVibePropsRequest

Request to update random vibe analysis properties.

FieldTypeLabelDescriptionproject[string](#string)Project name.ccaName[string](#string)CCA name.randomVibeDamping[string](#string)optionalModal Damping Ratio(s).naturalFreqMin[double](#double)optionalMin Frequency. For NX Nastran analysis only.naturalFreqMinUnits[string](#string)optionalMin Frequency units. For NX Nastran analysis only.naturalFreqMax[double](#double)optionalMax Frequency. For NX Nastran analysis only.naturalFreqMaxUnits[string](#string)optionalMax Frequency units. For NX Nastran analysis only.analysisTemp[double](#double)optionalTemperature.analysisTempUnits[string](#string)optionalTemperature units.partValidationEnabled[bool](#bool)optionalPart Validation.forceModelRebuild[string](#string)optionalModel Creation. Valid values are "FORCE" or "AUTO".reuseModalAnalysis[bool](#bool)optionalReuse Natural Frequency. For NX Nastran analysis only.performNFFreqRangeCheck[bool](#bool)optionalFrequency Range Check. For NX Nastran analysis only.requireMaterialAssignmentEnabled[bool](#bool)optionalRequire Material Assignment.modelSource[ModelSource](#modelsource)optionalOptional model source. Default: GENERATED.strainMapNaturalFreqs[string](#string)optionalComma-separated list of natural frequencies for strain map analysis.## UpdateSolderFatiguePropsRequest

Request to update solder fatigue properties.

FieldTypeLabelDescriptionproject[string](#string)Sherlock Project name.solderFatigueProperties[UpdateSolderFatiguePropsRequest.SolderFatigue](#updatesolderfatiguepropsrequest.solderfatigue)repeatedList of SolderFatigue properties to update for a CCA.## UpdateSolderFatiguePropsRequest.SolderFatigue

FieldTypeLabelDescriptionccaName[string](#string)The CCA name.solderMaterial[string](#string)optionalName of the solder material.partTemp[double](#double)optionalPart temperature rise.partTempUnits[string](#string)optionalPart temperature rise units.partTempRiseMinEnabled[bool](#bool)optionalFlag indicating if part temperature minimum rise should be enabled.partValidationEnabled[bool](#bool)optionalFlag indicating if part validation should be performed.## UpdateThermalMechPropsRequest

Request to update thermal mech analysis properties.

FieldTypeLabelDescriptionproject[string](#string)Project name.ccaName[string](#string)repeatedCCA names.thermalResultCount[int32](#int32)Thermal Mech Result Count.partValidationEnabled[bool](#bool)Part Validation.requireMaterialAssignmentEnabled[bool](#bool)Require Material Assignment.## ElementOrder

Enumeration defining the types of supported element orders.

NameNumberDescriptionUnknownOrder0Default enum to catch invalid element order.Linear1Enum for first order linear elements.Quadratic2Enum for second order quadratic elements.SolidShell3Enum for solid shell elements.## ModelSource

NameNumberDescriptionUNKNOWN0Default enum to catch invalid source.GENERATED1Generated analysis model source.STRAIN\_MAP2Strain map analysis model source.## AnalysisType

NameNumberDescriptionUNKNOWN0Default enum to catch invalid analysis.NaturalFreq1Enum for the Natural Frequency analysis.HarmonicVibe2Enum for the Harmonic Vibe analysis.ICTAnalysis3Enum for the ICT analysis.MechanicalShock4Enum for the Mechanical Shock analysis.RandomVibe5Enum for the Random Vibe analysis.ComponentFailureMode7Enum for the Component Failure Mechanism analysis.DFMEAModule8Enum for the DFMEA analysis.PTHFatigue9Enum for the PTH Fatigue analysis.PartValidation10Enum for the Part Validation analysis.SemiconductorWearout11Enum for the Semiconductor Wearout analysis.SolderJointFatigue12Enum for the Solder Fatigue analysis.ThermalDerating13Enum for the Thermal Derating analysis.ThermalMech14Enum for the Thermal Mech analysis.## AnalysisType

NameNumberDescriptionUNKNOWN0Default enum to catch invalid analysis.RandomVibe1Enum for the Random Vibe analysis.MechanicalShock2Enum for Mechanical Shock analysis.HarmonicVibe3Enum for the Harmonic Vibe analysis.## AnalysisType

NameNumberDescriptionUnknownAnalysisType0Default enum to catch invalid analysis.HarmonicVibe1Enum for the Harmonic Vibe analysis.ICTAnalysis2Enum for the ICT analysis.MechanicalShock3Enum for the Mechanical Shock analysis.NaturalFreq4Enum for the Natural Frequency analysis.RandomVibe5Enum for the Random Vibe analysis.ThermalMech6Enum for the Thermal Mech analysis.## PcbMaterialModel

NameNumberDescriptionUnknownPcbModel0Default enum to catch invalid PCB model.Uniform1Enum for uniform PCB model.Layered2Enum for layered PCB model.UniformElements3Enum for uniform elements PCB model.LayeredElements4Enum for layered elements PCB model.## PcbModelType

NameNumberDescriptionUnknownMeshType0Default enum to catch invalid mesh type.Bonded1Bonded FEA model.## SherlockAnalysisService

Method NameRequest TypeResponse TypeDescriptionrunAnalysis[.RunAnalysisRequest](#runanalysisrequest)[.ReturnCode](#returncode)Runs one or more Sherlock analysis.runStrainMapAnalysis[.RunStrainMapAnalysisRequest](#runstrainmapanalysisrequest)[.ReturnCode](#returncode)Run Sherlock strain map analysis.getHarmonicVibeInputFields[.GetHarmonicVibeInputFieldsRequest](#getharmonicvibeinputfieldsrequest)[.GetHarmonicVibeInputFieldsResponse](#getharmonicvibeinputfieldsresponse)Returns the list of valid harmonic vibe input fields for the provided model source and user configuration.updateHarmonicVibeProps[.UpdateHarmonicVibePropsRequest](#updateharmonicvibepropsrequest)[.ReturnCode](#returncode)Updates the analysis properties for harmonic vibe analysis.getRandomVibeInputFields[.GetRandomVibeInputFieldsRequest](#getrandomvibeinputfieldsrequest)[.GetRandomVibeInputFieldsResponse](#getrandomvibeinputfieldsresponse)Returns the list of valid Random Vibe input fields for the provided model source and user configuration.updateRandomVibeProps[.UpdateRandomVibePropsRequest](#updaterandomvibepropsrequest)[.ReturnCode](#returncode)Updates the analysis properties for random vibe analysis.getMechanicalShockInputFields[.GetMechanicalShockInputFieldsRequest](#getmechanicalshockinputfieldsrequest)[.GetMechanicalShockInputFieldsResponse](#getmechanicalshockinputfieldsresponse)Returns the list of valid mechanical shock input fields for the provided model source and user configuration.updateMechanicalShockProps[.UpdateMechanicalShockPropsRequest](#updatemechanicalshockpropsrequest)[.ReturnCode](#returncode)Updates the analysis properties for mechanical shock analysis.updateSolderFatigueProps[.UpdateSolderFatiguePropsRequest](#updatesolderfatiguepropsrequest)[.ReturnCode](#returncode)Updates the analysis properties for solder fatigue analysis.getNaturalFrequencyInputFields[.GetNaturalFrequencyInputFieldsRequest](#getnaturalfrequencyinputfieldsrequest)[.GetNaturalFrequencyInputFieldsResponse](#getnaturalfrequencyinputfieldsresponse)Returns the list of valid natural frequency property fields given the user configuration.updateNaturalFrequencyProps[.UpdateNaturalFrequencyPropsRequest](#updatenaturalfrequencypropsrequest)[.ReturnCode](#returncode)Updates the analysis properties for natural frequency analysis.updateThermalMechProps[.UpdateThermalMechPropsRequest](#updatethermalmechpropsrequest)[.ReturnCode](#returncode)Updates the analysis properties for thermal mech analysis.getPcbModelingInputFields[.GetPcbModelingInputFieldsRequest](#getpcbmodelinginputfieldsrequest)[.GetPcbModelingInputFieldsResponse](#getpcbmodelinginputfieldsresponse)Returns the list of valid PCB modeling property field.updatePcbModelingProps[.UpdatePcbModelingPropsRequest](#updatepcbmodelingpropsrequest)[.ReturnCode](#returncode)Updates the PCB modeling properties for the provided analysis types.getSolderFatigueInputFields[.GetSolderFatigueInputFieldsRequest](#getsolderfatigueinputfieldsrequest)[.GetSolderFatigueInputFieldsResponse](#getsolderfatigueinputfieldsresponse)Returns the list of valid solder fatigue property fields given the user configuration.updatePartModelingProperties[.UpdatePartModelingRequest](#updatepartmodelingrequest)[.ReturnCode](#returncode)Updates the part modeling properties for a given project's CCA.getICTAnalysisInputFields[.GetICTAnalysisInputFieldsRequest](#getictanalysisinputfieldsrequest)[.GetICTAnalysisInputFieldsResponse](#getictanalysisinputfieldsresponse)Returns the list of valid ICT analysis property fields given the user configuration.updateICTAnalysisProps[.UpdateICTAnalysisPropsRequest](#updateictanalysispropsrequest)[.ReturnCode](#returncode)Updates the analysis properties for ICT analysis.updatePartsListValidationProps[.UpdatePartsListValidationPropsRequest](#updatepartslistvalidationpropsrequest)[.ReturnCode](#returncode)Updates the analysis properties for parts list validation analysis.getPartsListValidationProps[.GetPartsListValidationPropsRequest](#getpartslistvalidationpropsrequest)[.PartsListValidationPropsResponse](#partslistvalidationpropsresponse)Returns the parts list validation properties.Back to [Top](#table-of-contents)