Click or drag to resize

PartServicesGetInternalParts Method

Retrieves one or more internal part definitions from the FactoryLogix parts database given a random list of part numbers (and revisions, if applicable).

Namespace:  FactoryLogix.xTend.PartDefinition
Assembly:  FactoryLogix.xTend.API (in FactoryLogix.xTend.API.dll) Version: 8.242.0.0 (8.242.0.0)
Syntax
public PagedSearchResults<InternalPart> GetInternalParts(
	Guid sessionId,
	RevisionKind revKind,
	AssemblyKind assyKind,
	string[] partNumbers,
	string[] revisions,
	int pageSize,
	int pageNumber
)

Parameters

sessionId
Type: SystemGuid
The session identifier that was returned by the Connect(String, String, String, String, String) method.
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.
partNumbers
Type: SystemString
A list of the part numbers of the part to be found. Only exact part numbers may be specified, and wildcard specifiers are not permitted.
revisions
Type: SystemString
A list of the part revisions to be used by the search. This list must either be empty or the same size as the partNumbers parameter. This parameter is ignored if the revKind parameter is set to any value other than RevisionKind.AllRevisions.
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: PagedSearchResultsInternalPart
A PagedSearchResultsT object containing 1 page worth of search results, where T is derived from type InternalPart. 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