    

 ## On this page

  

 

 # SherlockPartsService

 Last update: 17.07.2025 

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

## ExportNetListRequest

Contains the options needed to export a net list to a delimited output file (csv but can have delimiters other than a comma)

FieldTypeLabelDescriptionproject[string](#string)Sherlock project name.ccaName[string](#string)The CCA name.outputFilePath[string](#string)Full path of the file where the table will be written.overwriteExisting[bool](#bool)Flag to determine if existing files should be overwritten if they match the outputFilePath. False by default.colDelimiter[TableDelimiter](#tabledelimiter)Enum that specifies supported delimiter character to be used. Set to COMMA by default. Not applicable to Excel files like xls, xlsx.utf8Enabled[bool](#bool)Flag that specifies if UTF-8 will be used. False by default. Not applicable to Excel files like xls, xlsx.## ExportPartsListRequest

Request to export the parts list for all parts for a project CCA.

FieldTypeLabelDescriptionproject[string](#string)Sherlock project name.ccaName[string](#string)The CCA name.exportFile[string](#string)Full file path to the export parts list .csv file.## GetBoardSidesRequest

Request to list valid board sides.

## GetBoardSidesResponse

Represents a list of valid board sides.

FieldTypeLabelDescriptionreturnCode[ReturnCode](#returncode)Status code of response.boardSides[string](#string)repeatedBoard sides.## GetPartLocationRequest

Request to get a part's location.

FieldTypeLabelDescriptionproject[string](#string)Sherlock project name.ccaName[string](#string)The CCA name.refDes[string](#string)A comma separated list of reference designators for a list of parts, or a Ref Des for one part.locationUnits[string](#string)Unit of length for the part location. Supported values are IN, MM, M, MIL, MICRON, and NM.## GetPartLocationResponse

Represents one or multiple parts' location properties

FieldTypeLabelDescriptionreturnCode[ReturnCode](#returncode)Status code of response.locationData[GetPartLocationResponse.LocationData](#getpartlocationresponse.locationdata)repeatedList of location data for a part or list of parts in a specified project and CCA.## GetPartLocationResponse.LocationData

FieldTypeLabelDescriptionx[double](#double)Location of the part along the X axis.y[double](#double)Location of the part along the Y axis.rotation[double](#double)Rotation of the part on the board in degrees.locationUnits[string](#string)Unit of length for the part location.boardSide[string](#string)Side of board on which the component exists.mirrored[bool](#bool)Indicates if the component is mirrored across the Y-axis.refDes[string](#string)Ref Des for the corresponding part.## GetPartLocationUnitsRequest

Request to list valid location units.

## GetPartLocationUnitsResponse

Represents a list of valid location units.

FieldTypeLabelDescriptionreturnCode[ReturnCode](#returncode)Status code of response.units[string](#string)repeatedLocation units.## ImportPartsListRequest

Request to import a parts list for a project CCA.

FieldTypeLabelDescriptionproject[string](#string)Sherlock project name.ccaName[string](#string)The CCA name.importFile[string](#string)Full file path to the parts list .csv file.importAsUserSrc[bool](#bool)If true, set the data source of the properties to "User". Otherwise, set the data source to the name of the importFile.## ListPartsLibrariesRequest

Request to list the available parts libraries.

## ListPartsLibrariesResponse

Represents a list of available parts libraries.

FieldTypeLabelDescriptionreturnCode[ReturnCode](#returncode)Status code of response.partLibrary[string](#string)repeatedParts library name.## ListPartsNotUpdatedRequest

Request to get a list of parts not updated from the Sherlock Part Library.

FieldTypeLabelDescriptionproject[string](#string)Sherlock project name.## ListPartsNotUpdatedResponse

Represents a list of parts not updated from the Sherlock Part Library.

FieldTypeLabelDescriptionreturnCode[ReturnCode](#returncode)Status code of response.ccas[ListPartsNotUpdatedResponse.CCA](#listpartsnotupdatedresponse.cca)repeatedList of CCAs containing Parts not updated.## ListPartsNotUpdatedResponse.CCA

FieldTypeLabelDescriptionccaName[string](#string)The CCA name.parts[ListPartsNotUpdatedResponse.CCA.Part](#listpartsnotupdatedresponse.cca.part)repeatedList of Parts not updated for a CCA.## ListPartsNotUpdatedResponse.CCA.Part

FieldTypeLabelDescriptionrefDes[string](#string)Reference designator for the part.partNumber[string](#string)Part number.## UpdateLeadModelingRequest

Request to enable Lead Modeling for all non LEADLESS parts leads.

FieldTypeLabelDescriptionproject[string](#string)Sherlock project name.ccaName[string](#string)The CCA name.## UpdatePartsListFromAVLRequest

Request to update the parts list from AVL.

FieldTypeLabelDescriptionproject[string](#string)Sherlock project name.ccaName[string](#string)The CCA name.matching[MatchingMode](#matchingmode)How sherlock matches parts in the AVLduplication[DuplicationMode](#duplicationmode)How sherlock handles duplicate parts found.avlPartNum[AVLPartNum](#avlpartnum)Update part number and vendor/manufacturer or part number only.avlDesc[AVLDescription](#avldescription)Update description or not.## UpdatePartsListFromAVLResponse

FieldTypeLabelDescriptionreturnCode[ReturnCode](#returncode)Status code of response.numPartsUpdated[int32](#int32)Number of parts updated in the parts list.updateErrors[string](#string)repeatedSpecific errors that occured during update.## UpdatePartsListPropertiesRequest

Request to update one or more properties of one or more parts in a parts list.

FieldTypeLabelDescriptionproject[string](#string)Sherlock project name.ccaName[string](#string)The CCA name for which part properties will be updated.partProperties[UpdatePartsListPropertiesRequest.PartProperties](#updatepartslistpropertiesrequest.partproperties)repeatedList of parts with properties to be updated.## UpdatePartsListPropertiesRequest.PartProperties

FieldTypeLabelDescriptionrefDes[string](#string)repeatedThe reference designator for each part to be updated. If not included, update properties for all parts in the CCA.properties[UpdatePartsListPropertiesRequest.PartProperties.Property](#updatepartslistpropertiesrequest.partproperties.property)repeatedPart properties to be updated.## UpdatePartsListPropertiesRequest.PartProperties.Property

FieldTypeLabelDescriptionname[string](#string)Name of property to be updated.value[string](#string)Value to be applied to the chosen part property.## UpdatePartsListPropertiesResponse

Contains the status of the parts properties update as well as all the update error messages.

FieldTypeLabelDescriptionreturnCode[ReturnCode](#returncode)Status code of response.updateErrors[UpdatePartsListPropertiesResponse.PartPropertyError](#updatepartslistpropertiesresponse.partpropertyerror)repeatedPart property update errors.## UpdatePartsListPropertiesResponse.PartPropertyError

FieldTypeLabelDescriptionrefDes[string](#string)optionalThe reference designator of the part. Not set for invalid property name errors.message[string](#string)Error message when updating the part.## UpdatePartsListRequest

Request to update a parts list based on matching and duplication preferences provided.

FieldTypeLabelDescriptionproject[string](#string)Sherlock project name.ccaName[string](#string)The CCA name.partLibrary[string](#string)Parts library name.matching[MatchingMode](#matchingmode)Designates the matching mode for updates.duplication[DuplicationMode](#duplicationmode)Designates how to handle duplications during update.## UpdatePartsListResponse

Contains the status of the update as well as all of the update error messages.

FieldTypeLabelDescriptionreturnCode[ReturnCode](#returncode)Status code of response.updateError[string](#string)repeatedParts update error messages.## UpdatePartsLocationsByFileRequest

Request to update one or more parts' locations using a CSV file.

FieldTypeLabelDescriptionproject[string](#string)Sherlock project name.ccaName[string](#string)The CCA name.numericFormat[string](#string)Numeric format for the file. If not provided, it will default to "English (United States)".filePath[string](#string)File that contains the components and location properties.## UpdatePartsLocationsByFileResponse

Contains the status of the parts locations update as well as all the update error messages.

FieldTypeLabelDescriptionreturnCode[ReturnCode](#returncode)Status code of response.updateError[string](#string)repeatedParts locations update error messages.## UpdatePartsLocationsRequest

Request to set a part's location.

FieldTypeLabelDescriptionproject[string](#string)Sherlock project name.ccaName[string](#string)The CCA name.partLoc[UpdatePartsLocationsRequest.PartLocation](#updatepartslocationsrequest.partlocation)repeatedList of part locations to be updated for a specified project and CCA.## UpdatePartsLocationsRequest.PartLocation

FieldTypeLabelDescriptionrefDes[string](#string)Reference designator of the part.x[string](#string)Location of the part along the X axis.y[string](#string)Location of the part along the Y axis.rotation[string](#string)Rotation of the part on the board in degrees.locationUnits[string](#string)Unit of length for the part location. Supported values are IN, MM, M, MIL, MICRON, and NM.boardSide[string](#string)Side of board on which the component exists. Supported values are TOP and BOTTOM.mirrored[string](#string)Indicates if the component is mirrored across the Y-axis. Supported values are Y, and N.## UpdatePartsLocationsResponse

Contains the status of the parts locations update as well as all the update error messages.

FieldTypeLabelDescriptionreturnCode[ReturnCode](#returncode)Status code of response.updateError[string](#string)repeatedParts locations update error messages.## AVLDescription

Determines if the part description in the parts list will be updated by the AVL.

NameNumberDescriptionAssignApprovedDescription0Assign approved description.DoNotChangeDescription1Do not change description.## AVLPartNum

Determines what fields in the part list will get updated by the AVL.

NameNumberDescriptionAssignInternalPartNum0Assign internal part number.AssignVendorAndPartNum1Assign vendor &amp; part number.DoNotChangeVendorOrPartNum2Do not change vendor / part number.## DuplicationMode

Determines what happens when there are duplicate matches for parts in the part list against parts in the AVL or Part Library.

NameNumberDescriptionFirst0Uses first matched when there is duplication.Error1Generates an error when there is duplication.Ignore2Ignore the matches when there is duplication.## SherlockPartsService

Method NameRequest TypeResponse TypeDescriptionlistPartsLibraries[.ListPartsLibrariesRequest](#listpartslibrariesrequest)[.ListPartsLibrariesResponse](#listpartslibrariesresponse)List the available parts libraries.updatePartsList[.UpdatePartsListRequest](#updatepartslistrequest)[.UpdatePartsListResponse](#updatepartslistresponse)Update the parts list for a project's CCA.updatePartsListFromAVL[.UpdatePartsListFromAVLRequest](#updatepartslistfromavlrequest)[.UpdatePartsListFromAVLResponse](#updatepartslistfromavlresponse)Update the parts list from the AVL.updatePartsListProperties[.UpdatePartsListPropertiesRequest](#updatepartslistpropertiesrequest)[.UpdatePartsListPropertiesResponse](#updatepartslistpropertiesresponse)Update the values of given parts.listPartsNotUpdated[.ListPartsNotUpdatedRequest](#listpartsnotupdatedrequest)[.ListPartsNotUpdatedResponse](#listpartsnotupdatedresponse)List the parts that have not been updated from the Sherlock Part Library.updateLeadModeling[.UpdateLeadModelingRequest](#updateleadmodelingrequest)[.ReturnCode](#returncode)Enable lead modeling for all non LEADLESS parts leads in a project's CCA.exportPartsList[.ExportPartsListRequest](#exportpartslistrequest)[.ReturnCode](#returncode)Export parts list for all parts given a project's CCA.importPartsList[.ImportPartsListRequest](#importpartslistrequest)[.ReturnCode](#returncode)Import a parts list for a given a project's CCA.updatePartsLocations[.UpdatePartsLocationsRequest](#updatepartslocationsrequest)[.UpdatePartsLocationsResponse](#updatepartslocationsresponse)Update one or more parts' locations.updatePartsLocationsByFile[.UpdatePartsLocationsByFileRequest](#updatepartslocationsbyfilerequest)[.UpdatePartsLocationsByFileResponse](#updatepartslocationsbyfileresponse)Update one or more parts' locations using a CSV file.getPartLocationUnits[.GetPartLocationUnitsRequest](#getpartlocationunitsrequest)[.GetPartLocationUnitsResponse](#getpartlocationunitsresponse)Get a list of valid part location units.getBoardSides[.GetBoardSidesRequest](#getboardsidesrequest)[.GetBoardSidesResponse](#getboardsidesresponse)Get a list of valid board side values.getPartLocation[.GetPartLocationRequest](#getpartlocationrequest)[.GetPartLocationResponse](#getpartlocationresponse)Get the location properties for a part.exportNetList[.ExportNetListRequest](#exportnetlistrequest)[.ReturnCode](#returncode)Export the net list to a fileBack to [Top](#table-of-contents)