API Reference

This is the reference documentation of Tekla EPM Open API. The API contains request and response namespaces.

Meta.Microsoft.Help.Id
T:reqFabSuiteAPI.fsreqGetInventory

fsreqGetInventory Class

Retrieves all of the records from the current inventory and/or inventory history. Use IncludeInventory and IncludeHistory to specify that inventory and/or inventory history records should be retrieved. If neither the IncludeInventory or IncludeHistory elements are included then the command will retrieve inventory records only.
Inheritance Hierarchy

Namespace:  reqFabSuiteAPI
Assembly:  FabSuiteRequestApi (in FabSuiteRequestApi.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
C#
[SerializableAttribute]
[XmlTypeAttribute(Namespace = "http://www.fabsuite.com/xml/fabsuite-xml-request-v0108.xsd")]
public class fsreqGetInventory : fsreqCommand

The fsreqGetInventory type exposes the following members.

Constructors
  Name Description
Public method fsreqGetInventory
fsreqGetInventory class constructor
Top
Properties
  Name Description
Public property APILog
Indicates if this command should be logged to the database. The command must be of a type that supports logging to the database in order to take effect. Currently the commands supporting this option are: TFSCut
(Inherited from fsreqCommand.)
Public property CommandGUID
A GUID identifying this particular XML command. If a command fails due to a communication failure the client has no way of knowing if it has been processed. Each command that makes changes (as opposed to just retrieving data) will check the CommandGUID against the GUIDs that have already been processed. If the GUID has already been processed then it will not be re-processed and instead return with an error. This allows the client to saftely re-try a failed command without risking unintended changes.
(Inherited from fsreqCommand.)
Public property Filters
Nested Filters elements are supported.
Public property IncludeHistory
Indicates if information from Inventory History should be retrieved.
Public property IncludeInventory
Indicates if information from Inventory should be retrieved.
Public property InventoryItemID
The unique identifier for the inventory records to retrieve.
Public property LinkSoftware
Send External Inventory IDs for this software
Public property UseGradeSubstitutions
Indicates if grade substitutions should be considered when a grade filter is applied.
Top
See Also