Viewable Objects (OData+) - Intergraph Smart API Manager - 5.0 - Help

Intergraph Smart API Manager Help

Language
English
Product
Intergraph Smart API Manager
Search by Category
Help
Smart API Manager Version
5.0

Smart APIs use the Viewable Objects resource to support the ability to display any type of the viewable object, such as a graphics file or workspace.

You may find the Viewable Objects resource in two locations:

  • Bound to instances of an entity as contained navigation properties

  • Exposed as an entity set directly off the <service root> URL

A viewable object type typically inherits from Com.Ingr.Core.V1.ViewableObject or implements its interface. In the latter case, you must cast an entity instance to Com.Ingr.Core.V1.ViewableObject type before calling its bound operations. For example, if you look at the metadata annotations document:

https://sam.spclouddave.com/sampleservice/Sppid/V3/annotations/$metadata

you will find that all File resources implement the Com.Ingr.Core.V1.ViewableObject interface:

<Annotations Target="Com.Ingr.Core.V1.File">

<Annotation Term="Org.OData.Core.V1.MayImplement">

<Collection>

<String>Com.Ingr.Core.V1.ViewableObject</String>

</Collection>

</Annotation>

</Annotations>