Entities - Intergraph Smart 3D Web API - Customization & Programming - Hexagon PPM

Intergraph Smart 3D Admin Web API Programmers Reference

Language
English
Product
Intergraph Smart 3D Web API
Subproduct
Smart 3D Web APIs
Search by Category
Customization & Programming
Smart 3D Version
13

The Entities in the Smart 3D Admin Web API EDM are based on the data required to do all Admin activities. Following are the entities:

  • Site

  • Catalog

  • Plant

  • Model

  • PermissionGroup

  • PermissionGroupFolder

  • AccessControlRule

  • Location

  • Class, ClassTool, ClassMap

  • Interface, InterfaceTool, InterfaceMap

  • Property, PropertyTool, PropertyMap

  • List, ListTool, ListMap

  • ListItem, ListItemTool, ListItemMap

All entities directly or indirectly have a base class defined as DynamicEdmEntityObject. It has two properties: Id and ConcurrencyToken. Id contains the UID as described in Unique Identifier (UID). ConcurrencyToken is a generated property that is used to determine if the current object is up-to-date when performing PATCH operations to update an object.

<EntityType Name="DynamicEdmEntityObject" Abstract="true" OpenType="true">

<Key>

<PropertyRef Name="Id" />

</Key>

<Property Name="Id" Type="Edm.String" Nullable="false" />

<Property Name="ConcurrencyToken" Type="Edm.String" />

Note the PermissionGroup and PermissionGroupFolder entities derive from the S3DItem base class, which is defined as:

<EntityType Name="S3dItem" BaseType="Com.Ingr.Core.V1.DynamicEdmEntityObject" Abstract="true" OpenType="true">

<Property Name="ClassName" Type="Edm.String" />

<Property Name="DateCreated" Type="Edm.DateTimeOffset" />

<Property Name="DateLastModified" Type="Edm.DateTimeOffset" />

<Property Name="UserCreated" Type="Edm.String" />

<Property Name="UserLastModified" Type="Edm.String" />

<Property Name="ApprovalStatus" Type="Edm.Int64" />

<Property Name="ApprovalReason" Type="Edm.Int64" />

</EntityType>

The S3dItem Entity base type is DynamicEdmEntityObject.