A client API represents a piece of code that can be invoked through the configuration of a method. The client API represents actual lines of code in the client that performs a generic function. A configured method applies further specifics to the execution of that code through method parameters or arguments. For example, the CreateObj client API generically handles the creation of objects. However, you can modify the method parameters to create specific items, such as Create Folder.
The following section provides information about navigating to client APIs and their methods in HxGN SDx.
How to use this information
You can use the search in the help to find the following:
-
A specific client API
-
A specific method
Tips for navigating APIs and methods
|
If you are |
In order to view |
You can do this |
|---|---|---|
|
In the Web Client |
A client API, its parameters, or related methods. |
Use the Search box to search for a specific client API or select the Client APIs search function in the System Administration feature set. |
|
In the help |
A client API, its parameters, or related methods. |
Use the Search box to search using keywords, a specific client API name or method. |
|
In the Desktop Client |
Methods related to a client API |
|
|
Arguments related to a method |
|
|
|
Parameters related to a client API |
|