Reports (OData+) - Intergraph Smart API Manager - 2020 (4.0) - Help

Intergraph Smart API Manager Help

Language
English (United States)
Product
Intergraph Smart API Manager
Search by Category
Help

A report is typically data formatted and presented to an end user based on a request. Most Smart APIs contain some type of reporting feature for extracting data, formatting data, and presenting the result to the end user.

Smart APIs use the Reports resource to support the ability to run reports associated with an application.

You will find the Reports resource in one of two locations:

  • Bound to instances of an entity set.

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

For example, the SampleService Smart API does not contain Reports at its service root:

https://sam.spclouddave.com/SampleService/Sppid/v2/

But if you look at the metadata document:

https://sam.spclouddave.com/SampleService/Sppid/v2/$metadata

you will find Reports bound to the Pipe entity:

<EntityType Name="Pipe"

BaseType="Com.Ingr.Sppid.V1.Equipment"

OpenType="true">

.

<NavigationProperty Name="Reports"

Type="Collection(Com.Ingr.Core.V1.Report)"

ContainsTarget="true"/>

.

</EntityType>