Working with Client APIs - SmartPlant Foundation - IM Update 48 - Help - Hexagon

SmartPlant Foundation Help

Language
English
Product
SmartPlant Foundation
Search by Category
Help
SmartPlant Foundation / SDx Version
10
SmartPlant Markup Plus Version
10.0 (2019)
Smart Review Version
2020 (15.0)

The following section provides information about navigating to client APIs and their methods.

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, using keywords and filters, to a specific client API name or method.

In the Web Client Help

A client API, its parameters, or related methods.

Use the Search box to search, using keywords, to a specific client API name or method.

In the Desktop Client

Methods related to a client API

  1. Click Find > Administration > Client API, and then search for the API.

  2. Right-click the API in the search results, and click Show Methods.

Arguments related to a method

  1. Click Find > Administration > Method.

  2. Right-click a method name and select Details.

Parameters related to a client API

  1. Click Find > Administration > Client API, and then search for the API.

  2. Right-click an API name and select Details.