Reports - Intergraph Smart Instrumentation - Version 2.3.3 - Training - Intergraph

Requires access to Smart Instrumentation desktop.

Smart Instrumentation API reports for specific entity types are derived from the Entity Data Model (see request 01.03 Get EDM (Entity Data Model)) navigation properties where available. For example, a Panel entity type includes a navigation property to Reports.

Other entity types that provide reports are Loop, Instrument, and cable.

Reports must be generated to a shared folder which has read & write permissions and the file extension set as pdf.

The following reports are available:

Get Report List for Device Panel

The following GET request provides the list of reports for a selected Device Panel. Make sure you always provide the Id of the specific item, for the requested report list.

It is good practice to include the project as well.

• Select the 07.01 Get Report List for Device Panel request and click Send.

  {{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Projects('0')/PanelProject('4156')/Reports

  Reports for panel 101-FT -100 appear in the response payload.

  

Get Specific Panel Report

The following GET request retrieves a specific report by including the report Id from the previous request.

• Select the 07.02 Get Specific Panel Report request and click Send.

  {{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Projects('0')/PanelProject('4156')/Reports('101-FT   -100|PSSTL1')

  The request lists only the selected report.

Execute Report — Device Panel w/Adjacent Connections.

The following POST request executes the report action.

You use the same request as in the previous request while adding "/Com.Ingr.Core.V1.ExecuteReport" at the end of it and change it to a POST type of request instead of GET.

• All Web API actions require parameters in the body of the request. In the case of Execute report, just include curly {} brackets in the body.
  

• The Execute report action request requires that the Header , Content-Type key have the vale application/json.
  

  

1. Select the 07.03 ExecuteReport action for Panel-Strip w/Adjacent Connection request and click Send.

   {{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Projects('0')/PanelProject('4156')/Reports('101-FT   -100|PSSTL1')/Com.Ingr.Core.V1.ExecuteReport

   Payload response example:

   

   The last line includes a Url that points to a shared folder with the report file in a PDF format.

2. Copy the Url and paste it into a browser's address bar, and press Enter.

   

When a panel has multiple terminal-strips, the report file will include all the terminal strip reports in one file.

Get Report List for DCS

The following GET request provides the list of reports for a selected DCS Panel.

• Select the 07.04 Get Report List for DCS request and click Send.

  {{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Projects('0')/PanelProject('4462')/Reports

  Reports for panel 101-DCS-001 appear in the response payload (the following is a partial list).

  

Execute Report – DCS I/O Assignment

This POST request executes the report action to create the I/O Assignment report.

1. Select the 07.05 ExecuteReport action for DCS I/O Assignment request and click Send.

   {{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Projects('0')/PanelProject('4462')/Reports('101-DCS-001|PSIOASS')/Com.Ingr.Core.V1.ExecuteReport

2. Copy the Url and paste it into a web browser, and then press Enter.

Get Report List for Instrument

The following GET request provides the list of reports for a selected instrument.

1. Select the 07.06 Get Report List for Instrument request and click Send.

   {{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Projects('0')/InstrumentProject('4153')\Reports

   The list includes several report types for instrument 101-FT -100.

   In some cases where the report name or the item name include a forward slash ("/"), it is being replace with a double escape code "%252f" since the OData will not accept this character in the request. You use the Id as it is to execute the report.

   

2. Review the rest of the reports in the list.

Execute Report - Loop report for Instrument 101-FT -100

This POST request execute the report action to create the enhanced loop report.

1. Select the 07.07 ExecuteReport action for Instrument's Enhanced Loop request and click Send.

   {{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Projects('0')/InstrumentProject('4153')\Reports('101-F -100|RADSLOOP')/Com.Ingr.Core.V1.ExecuteReport

   

2. Copy the Url and paste it into a browser's address bar and press Enter.

   

Download PDF Report

To download a report, you must first generate the report as a .pdf file. In this example you will download the report that was executed in the previous request (07.07).
The GET request ends as follows: …\Reports('<Report Id'>/Instances('<File name>')/$value

Select the 07.08 Download PDF Report and click Send.

{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Projects('0')/InstrumentProject('4153')\Reports('101-F -100|RADSLOOP')/Instances('101-F -100.pdf')/$value

Depending on the client and operating system, you may be prompted to save the file.

Get Report List for Panel Strip

The following GET request provides a list of reports for a terminal strip TS-1 of junction box 101-JB-DCS-001.

Select the 07.09 Get Report List for Terminal Strip request and click Send.

{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Projects('0')/PanelProject('4573')/TerminalStripPanel('4573_13862')/Reports

Prior to this request it is required to find the relevant IDs of the panel and terminal strip.

Execute Report – Panel-Strip Enhanced report for terminal strip TS-1

This POST request executes the report action to create the enhanced panel-strip report.

Select the 07.10 Execute Report – Panel-Strip Enhanced report for terminal strip TS-1 request and click Send.

{{baseUri}}api/si/{{versionNumber}}/Sites('{{SiteId}}')/PlantGroups('{{PlantGroupId}}')/Projects('0')/PanelProject('4573')/TerminalStripPanel('4573_13862')/Reports('101-JB-DCS-001|TS-1|RADSTRIP')/Com.Ingr.Core.V1.ExecuteReport

Copy the Url and paste it into a browser's address bar, and press Enter.