API Reference

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

fsreqExtensionCommand Class

Execute a Tekla EPM Extension
Inheritance Hierarchy

Namespace:  FabSuiteRequestApi
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 fsreqExtensionCommand : fsreqCommand

The fsreqExtensionCommand type exposes the following members.

Constructors
  NameDescription
Public methodfsreqExtensionCommand
Initializes a new instance of the fsreqExtensionCommand class
Top
Properties
  NameDescription
Public propertyAPILog
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 propertyCommandGUID
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 propertyCommandName
The name of the command to execute
Public propertyExtensionID
The ID of the extension to call
Public propertyOptions
A JSON string of options to the command
Top
See Also