Skip to main content
InSource KnowledgeCenter

TN InSight018 How to query AVEVA Insight API and return data using Postman

Description

 

This article from InSource shows how to query AVEVA Insight and return process value(s) using Postman.

  • Author: Ron Tanner
  • Published: 12/13/2019
  • Applies to: AVEVA Insight

Details

Example Steps:

1.) Access your AVEVA Insight and click the “Insight Suite” in the upper right.
clipboard_ef48aa823557971b04d78e1e60f98c5bb.png

2.) Click the “Administration” icon

clipboard_eba2dff111082fa641888aacc48e769bf.png


3.) Click the “REST API” on the “Integration Settings” tile.

clipboard_ed796332ac8f69ac6cd2a2d4cd6578e33.png


4.) For this example, we will use Basic Authentication:  Copy the “Endpoint” URL

clipboard_e18593acfc50715fbdc41d1e38219ddd8.png

 

5.)    Download postman from https://www.getpostman.com/downloads/
clipboard_e191f8c6eef1ecfb3f9147d1e2de813be.png
 

6.)    After installation run Postman and select the “New” option in the upper left.

clipboard_e3aefa31540993601357889cf37c3b5c9.png

 

7.)    Click the “GET Request” tile

clipboard_e1527de5d639d37aec40ca06a5919f582.png

 

8.)    Fill in the “Save Request” form and click the save at the bottom.  You can also create a collection to help with organizing your workspaces.

clipboard_e7430f1a8d840fab01126ac329c7d9795.png

 

9.)    Click on the “Authorization” tab and fill in your AVEVA Insight Username and Password and choose “Basic Auth”

clipboard_eb04798796264b441ed08d5457fa11364.png

 

10.) Fill in the “GET” URL.  The URL is built starting with the URL from step 4 above along with different parameters which can be found in the AVEVA REST API documentation on the AVEVA Insight website.

 

The following URL GET’s the ProcessValue using the endswith filter option.  The example tag is “Baltimore.Labeler1.Performance”

https://online.wonderware.com/a/1234...r=endswith(FQN, 'Baltimore.Labeler 1.Performance')

clipboard_ea56df73a8198adbddf36f89c65e602e5.png

 

11.)  Click the “Send” button and the results will show up in the “Body” section.  You can test different queries before using them in another 3rd party application.  You can also specify different formats.

clipboard_e587de5ccda8ec4d154119ae3763adc53.png
 

Postman is a great tool to test getting and putting data from AVEVA Insight.