Get the Select Lists - 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

The Select Lists endpoint in Web API v1 returns every EnumListType found in the database. A Select List parent contains descendants, which are other EnumListTypes related to the Select List by a Contains relationship. The ID of a Select List is taken from the Select List UID in the database.

Each Select List contains EnumEnum object items that are related to the Select List by a Contains relationship. For example, the FusionDocumentStatus Select List contains the items Document Loaded and Document Processed.

You can use the following GET to return the Select Lists:

. . /api/v1/SelectLists

Alternatively you can use the Select List UID to query for a single Select List:

. . /api/v1/SelectLists('e1SPFSystemDocuments')

Descendants

You can view the Select List descendants either by expanding or navigating to the Descendants property, as follows:

. . /api/v1/SelectLists?$expand=Descendants

. . /api/v1/SelectLists('e1SPFSystemDocuments')/Descendants

For example, you can use the following GET to expand to the Descendants:

. . /api/v1/SelectLists('e1SPFSystemDocuments')?$expand=Descendants

Parents

You can view the Select List parent by either expanding or navigating to the Parents property, as follows:

. . /api/v1/SelectLists?$expand=Parents

. . /api/v1/SelectLists('e1AdapterDocument')/Parents

For example, you can use the following GET to expand to the Parents:

. . /api/v1/SelectLists('e1AdapterDocument')?$expand=Parents

Object items

You can view the object items contained in Select Lists by expanding or navigating to the Items property:

. . /api/v1/SelectLists?$expand=Items

. . /api/v1/SelectLists('e1DocumentStatus')/Items

For example, you can use the following GET to expand to the Items property:

. . /api/v1/SelectLists('e1DocumentStatus')?$expand=Items