Click or drag to resize

StationSetupServicesGetRequiredSetup Method

Retrieves the required setup for a particular Operation at a particular Workstation.

Namespace:  FactoryLogix.xTend.Production
Assembly:  FactoryLogix.xTend.API (in FactoryLogix.xTend.API.dll) Version: 8.245.0.0 (8.245.0.0)
Syntax
Copy
public RequiredSetup GetRequiredSetup(
	Guid sessionId,
	Guid operationId,
	Guid workstationId,
	Nullable<Guid> batchId
)

Parameters

sessionId
Type: SystemGuid
The session identifier that was returned by the Connect(String, String, String, String, String) method.
operationId
Type: SystemGuid
The Id of the realted Operation.
workstationId
Type: SystemGuid
The Id of the related Workstation.
batchId
Type: SystemNullableGuid
An optional Id of the related Batch. This is only necessary for Configure To Order (CTO) type production, where the required setup might vary based on configured options.

Return Value

Type: RequiredSetup
A RequiredSetup object containing the required setup for the Operation / Workstation.
Exceptions
ExceptionCondition
InvalidSessionExceptionThrown if the sessionId parameter is invalid.
OperationNotFoundExceptionThrown if the operationId parameter is invalid.
ResourceNotFoundExceptionThrown if the workstationId parameter is invalid.
BatchNotFoundExceptionThrown if the batchId property is not null and is invalid.
See Also