Media entities - 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

A Smart API may contain viewable object resources (derived from the Com.Ingr.Core.V1.ViewableObject entity type) that support OData media entities to enable streaming out-of-band content, such as a photograph or video.

Media entities are identified by the HasStream="true" attribute in metadata, for example:

<EntityType Name="ViewFile BaseType="Com.Ingr.Core.V1.File" IsOpen="true" HasStream="true">

.

</EntityType>

A client can request to stream the drawing file's content by adding a $value segment to the end of the resource URI, for example:

GET https://myserver.com/ViewAPI/v3/ViewableObjects('13')/$value

Media entities are not implemented for viewable files in the SampleService. The annotations and URI shown are for demonstration purposes only. However, the SampleService does support media entities for Reports. See Media entities for details.