GET Requests of Select Lists - Intergraph Smart Instrumentation - Help - Intergraph

Intergraph Smart Instrumentation Smart API Tutorial

PPMProductFamily
Engineering and Schematics
PPMProduct
Intergraph Smart Instrumentation
PPMCategory
Help
Version_WebSI
2.1

Select Lists in Smart Instrumentation's metadata are exposed at the PlantGroup (domain) level.

GET Select Lists

This request reveals the select lists in a specific site.

  • Select the 08.01 Get Select Lists request and click Send.

    {{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/SelectLists

    Each select list has a unique Id which is identified in the respective reference annotation (of the base model or the PlantGroup’s annotation or even in both). The PlantGroup annotation describes the enabled UDTs and UDFs and their relation to the respective select-list.

GET Select List Items

This request retrieves all the entries of Panel Category select list. You use this request when you want to get the collection of all the items of a specific select list.

  • Select the 08.02 Get Select List items request and click Send.

    {{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/SelectLists('1001')/Items

    If you need to get a specific item within a select list, you can request it by specifying it’s Id.

    For example, to get Id=2 of this select list, duplicate the request and modify the new one as follows:

    {{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/SelectLists('1001')/Items('2')

GET Select List Parent

This request retrieves the parent select list definition of the panel model select list.

  • Select the 08.03 Get Select List Parent request and click Send.

    {{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/SelectLists('1310')/Parent

    This select list request is a special case due to the dependency between the model and the manufacturer. Most select lists do not have dependencies.

GET Select List Descendant

This request retrieves the descendant select list of the panel manufacturer select list.

  • Select the 08.04 Get Select List Descendant request and click Send.

    {{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/SelectLists('1309')/Descendant

    This select list request is a special case due to the dependency between the model and the manufacturer. Most select lists do not have dependencies.

Get Select List (1085) and a Specific Item

This request gets a specific item from a specific select list, in this example select list 1085.

Select the 08.05 Get Specific Select List Item (Id=4071 for Select List Id =1085) request and click Send.

{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/SelectLists('1085')/Items('4071')