Expose interface definitions - HxGN SDx - Update 63 - Administration & Configuration - Hexagon

HxGN SDx API Services Configuration

Language
English
Product
HxGN SDx
Search by Category
Administration & Configuration
SmartPlant Foundation / SDx Version
10

This topic has been modified from Update 57. For previous versions, see Expose interface definitions (modified in an update).

You can expose interface definitions using a new API Entry Point.

  1. In the Web Client, use the search bar to search for the interface definition.

  2. Select the Interface Definition in the results, and select Actions > Create API Entry Point.

  3. In the New API Entry Point form Main Details tab, enter a name and description for the new API Entry Point.

  4. In the API Entry Point details section, type the name for the interface definition that you want to expose in the Metadata Entity Single Name box. For, example, IDataflow.

  5. In the Metadata Entity Collection Name box, type the name for the collection of interface definitions you want to expose. For example, Dataflow.

  6. In the Property Comparison box, you can optionally configure additional query criteria for the exposed type using standard property comparison syntax.

  7. In the ColumnSet list, select the column set to be exposed to the selected interface definition.

    The column set's related properties and relationship definitions are exposed to the selected interface definition. If no column set is selected, the column set is selected automatically by the system.

  8. Select the various other options as applicable, such as the Disable peek.

  9. In the Entry point for APIs UI details section, select the options to hide or group the API Entry Point from the home page and list.

  10. In the GUI display details section, type the name for the new API entry point in the Display as box.

  11. In the Required Access Groups tab, select the access groups to the API Entry Point, and select ADD.

  12. Select FINISH to create the API Entry Point.

To expose interface definitions

Interface definitions are not automatically exposed by relating a ClassDef or Component Schema to an API group. You can expose the InterfaceDefs by setting the SPFInterfaceDefExposedName and SPFInterfaceDefExposedSetName properties to True and then create a relationship from the InterfaceDef to an API Group.