Client Application Programming Interface (API) (modified in an update) - HxGN SDx - HxGN SDx - Reference - Hexagon

HxGN SDx Modified and Retired Functionality

Language
English
Product
HxGN SDx
Search by Category
Reference
SmartPlant Foundation / SDx Version
10
SmartPlant Markup Plus Version
10.0 (2019)

The following applies if you are using a version of the software before Update 60. For the latest information, see Working with Client APIs .

A client API represents a piece of code that can be invoked through configuration of a method. The client API represents actual lines of code in the client that can perform some generic function. A configured method will apply further specifics to the execution of that code through parameters, known as method arguments. An example is the CreateObj client API. This is code that generically handles the creation of any unclassified objects. However, through the parameters on a method, you can turn that into something specific like Create Host or Create Folder.

Use Find > Administration > Client APIs in the Desktop Client to find client APIs in the system. For information about the client APIs, and the methods that use them.