Click or drag to resize

PartServicesFindParts Method

Retrieves one or more part definitions from the FactoryLogix parts database. The flagged, enumerated partKind parameter determines the kind of parts to be retrieved (InternalPart, ManufacturerPart, VendorPart, or CustomerPart). The wildcard specifier "*" may be incorporated into any of the search criterial parameters. If no wildcard specifiers are used, the search string must exactly match the item sought (not case sensitive). A wildcard specifier of "*" for the partNumber parameter returns all known parts (filtered by the "kind" parameters).

Namespace:  FactoryLogix.xTend.PartDefinition
Assembly:  FactoryLogix.xTend.API (in FactoryLogix.xTend.API.dll) Version: 8.242.0.0 (8.242.0.0)
Syntax
Copy
public PagedSearchResults<PartBase> FindParts(
	Guid sessionId,
	PartKind partKind,
	RevisionKind revKind,
	AssemblyKind assyKind,
	string partNumber,
	string revision,
	string relatedItem,
	int pageSize,
	int pageNumber
)

Parameters

sessionId
Type: SystemGuid
The session identifier that was returned by the Connect(String, String, String, String, String) method.
partKind
Type: FactoryLogix.xTend.DataObjectsPartKind
A flagged, enumerated value indicating the type(s) of parts to search for. It is permissable to search for more than one type in a single search.
revKind
Type: FactoryLogix.xTend.DataObjectsRevisionKind
An enumerated value of type RevisionKind indicating how multiple revisions of the same part shall be considered by the search.
assyKind
Type: FactoryLogix.xTend.DataObjectsAssemblyKind
An enumerated value of type AssemblyKind indicating how the search should filter based on the part's assembly flag.
partNumber
Type: SystemString
The part number of the part to be found. The wildcard specifier ("*") may be incorporated into this search parameter.
revision
Type: SystemString
The revision of the part to be found. The wildcard specifier ("*") may be incorporated into this search parameter. This parameter is ignored if the revKind parameter is set to any value other than RevisionKind.AllRevisions.
relatedItem
Type: SystemString
For customer, manufacturer, and vendor part searches, the related customer, manufacturer, or vendor. The wildcard specifier ("*") may be incorporated into this search parameter.
pageSize
Type: SystemInt32
The maximum number of records to be returned by each single call to this method. This parameter must fall within a range of 0 to a maximum value of 500. If a value of 0 or null is specified, the default page size of 20 will be used.
pageNumber
Type: SystemInt32
The page number of the result set to be retrieved when the search results in a result set greater than the page size. By default, a value of 1 will be used if this parameter is null or 0. A value of -1 indicates that the last page is desired.

Return Value

Type: PagedSearchResultsPartBase
A PagedSearchResultsT object containing 1 page worth of search results, where T is derived from type PartBase. If the result set of the search is greater than the page size, the return object contains the total number of pages which may be used by subsequent calls to retrieve more pages worth of result data.
Exceptions
ExceptionCondition
InvalidSessionExceptionThrown if the sessionId parameter is invalid.
NotAuthorizedExceptionThrown when not authorized to perform the function.
See Also