manualshive.com logo in svg

MSA Grid RESTful API, Startup Manual, Page: 4 / 53

Share
Download
MSA Grid RESTful API Startup Manual Download Page 4

 

 
 
 

 

Grid RESTful API Start-up Guide 

4 

 
 

Quick Start Guide 

1.  Open the preferred RESTful client.  

2.  Authenticate with www.FieldPoP.io/rest/login. 

3.  Test the API.  

a.  Set up a sample 

b.  Run the sample 

4.  Run GET device data log commands. 

Summary of Contents for Grid RESTful API

Page 1: ...Grid RESTful API Start up Guide 0 Start up Guide Grid RESTful API MSAsafety com Document Revision 2 A T18663 APPLICABILITY EFFECTIVITY Effective for all systems manufactured after August 2021...

Page 2: ...MSA Safety 1991 Tarob Court Milpitas CA 95035 Website www MSAsafety com U S Support Information 1 408 964 4443 1 800 727 4377 Email smc support msasafety com EMEA Support Information 31 33 808 0590 Em...

Page 3: ...e 3 Assumptions The following items should be complete before moving forward with Grid RESTful API setup Install preferred RESTful client program Setup a Grid account Login to a computer with access t...

Page 4: ...ul API Start up Guide 4 Quick Start Guide 1 Open the preferred RESTful client 2 Authenticate with www FieldPoP io rest login 3 Test the API a Set up a sample b Run the sample 4 Run GET device data log...

Page 5: ...2 6 Firmware Methods 41 2 6 1 GetDeviceFirmwareVersions 41 2 6 2 UpgradeFirmware 42 3 Additional Information 43 3 1 General Notes 43 3 1 1 How to Obtain an IIoT Device ID DeviceID Parameter Value 43 3...

Page 6: ...id RESTful API acts as a RESTful server using HTTPS The API will support authentication read operations and write operations including Read HTTP GET o data logs recorded on the Grid o event logs recor...

Page 7: ...happn_token rest method fieldpop api deviceDataLog happn_token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9 ImlkfGNiMmQ0N Dg5LTAyNTQtNGJlYy1hZWNiLThkZDM3NDY0NjA3Mnx0eXBlfHRpbWVzdGFtcHxpc0VuY3J5cHRlZHxvcmlnaW5...

Page 8: ...SF9HU1QvfGlzVG9rZW58dXNlcm5hbWV8ZWdnZ XJzamVuc0BnbWFpbC5jb21eMHxKNjZCOFBGR3wwfDBeXiQwfDF8MnxIfDN8SXw0fC0yfDV8Nnw3fCQ4fCQ5fEp8QXwtM11 8QnwkOXxLfEF8LTNdXXxDfER8RXwtMXxGfEddIg ihjURRHILcXp iTl4FvjjAma1sI...

Page 9: ...poch JSON Response Object containing time series data Example GET URL rest method fieldpop api deviceDataLog happn_token eyJ0eXAiOiJKV1QiLCJhbGci deviceID lavenderqueste r_4k9q5oU Q startUTCsec 150237...

Page 10: ...N Response data object includes all data matching specified path parameter no path all available data for all devices device all available properties for specified device device property value of spec...

Page 11: ...or null Example JSON Response path Device_1_Profile_1 message Call successful data parameters node_id 1 parameter1 1 parameter2 1 type Device1 mapping Device1 name Device_1_Profile_1 path profileView...

Page 12: ...y for device BAC_IP_Falcon_Steam_2_ INLETWATERTEMPDEGF shagcrest_Nk9hhqHFz data data BAC_IP_Falcon_Hydronic data 48 data 78 8 error message Unknown field device BAC_IP_Falcon_Steam_2_ error message Un...

Page 13: ...matic example of the full available data for a given user gateway_1 data parameters node_id 1 type BAC_IP_Falcon_Hydronic mapping BAC_IP_Falcon_Hydronic name BAC_IP_Falcon_Hydronic_1_ path profileView...

Page 14: ...pecifying the target IIoT device s o deviceID the IIoT gateway ID see Section 3 1 1 o deviceFilter MongoDB style query object see https www npmjs com package sift this option can only be specified by...

Page 15: ...atus_class status_normal status Normal oldStatus Normal BURNER_ENABLE 1 gateway_2 data parameters node_id 1 type BAC_IP_Falcon_Hydronic mapping BAC_IP_Falcon_Hydronic name BAC_IP_Falcon_Hydronic_1_ pa...

Page 16: ...alse trouble false warning false activeEvents address 2 status_class status_normal status Normal oldStatus Normal BURNER_ENABLE 1 error null Example 3 POST URL rest method fieldpop api getDeviceData h...

Page 17: ...eyJ0eXAiOiJKV1QiLC Example 4 JSON POST path and dataFilter specified but no IIoT device selector parameters path property0 property1 events alarm options dataFilter name eq Device_1_Profile_1 Example...

Page 18: ...r specified parameters deviceFilter state eq Alarm path name type status BOILERLEADLAGSETPOINTDEGC BURNER_ENABLE options dataFilter status eq Alarm Example 5 JSON Response message Call successful data...

Page 19: ...the login request HTTP Headers Content Type application json Body Parameters JSON parameters object containing the following fields o deviceID the IIoT gateway ID see Section 3 1 1 o path the path of...

Page 20: ...n token obtained from the login request HTTP Headers Content Type application json Body Parameters JSON parameters object containing the following fields o deviceID the IIoT gateway ID see Section 3 1...

Page 21: ...Grid GUI on the device also visible on the Grid website by clicking on the device pin on the map o path the path of the value to get must be 3 levels deep deviceInstance objectType objectInstance prop...

Page 22: ...meter selecting only certain data paths to be read from the selected downstream devices using the path parameter Parameters happn_token token obtained from the login request deviceAPIVersion see Secti...

Page 23: ..._TEMPERATURE properties present value propertyIdentifier present value value value 39 79999923706055 type REAL lastRead 1513687777060 log enabled true keys 1 analog input 2 present value deviceInstanc...

Page 24: ...type REAL lastRead 1513687777497 log enabled false keys analog input 2 objectType analog input objectInstance 2 objectName OUTSIDE_TEMPERATURE properties present value propertyIdentifier present valu...

Page 25: ...ctName INSIDE_TEMPERATURE properties present value propertyIdentifier present value value value 87 9000015258789 type REAL lastRead 1513689232285 log enabled false keys analog input 2 objectType analo...

Page 26: ...REAL lastRead 1513689232174 log enabled true keys 1 analog input 2 present value deviceInstance 2 deviceName WeatherLink_2 pollInterval 5 offline false objects analog input 1 objectType analog input...

Page 27: ...objects analog input 1 properties present value lastRead 1513692188395 deviceName WeatherLink_2 offline false objects analog input 1 objectName INSIDE_TEMPERATURE objects analog input 1 properties pr...

Page 28: ...meters deviceFilter state eq Alarm deviceAPIVersion 2 Example 6 JSON Response message Call successful data gateway_1 data deviceInstance 1 deviceName WeatherLink_1 pollInterval 5 offline false objects...

Page 29: ...tyIdentifier present value value value 88 5999984741211 type REAL lastRead 1513693293192 log enabled false keys analog input 2 objectType analog input objectInstance 2 objectName OUTSIDE_TEMPERATURE p...

Page 30: ...happn_token token obtained from the login request deviceID the IIoT gateway ID see Section 3 1 1 methodName getBACnetDeviceInfo deviceInstance the BACnet device instance Example URL HTTP POST rest me...

Page 31: ...Parameters happn_token token obtained from the login request deviceAPIVersion see Section 2 3 5 deviceID the IIoT gateway ID see Section 3 1 1 methodName getBACnetDeviceInfo deviceInstance the BACnet...

Page 32: ...en obtained from the login request deviceAPIVersion see Section 2 3 5 deviceID the IIoT gateway ID see Section 3 1 1 methodName getBACnetPropertyValue deviceInstance the BACnet device instance objectT...

Page 33: ...tance the BACnet device instance objectType the BACnet object type objectInstance the BACnet object instance propertyIdentifier the BACnet property identifier propertyValue the value to write priority...

Page 34: ...ent user HTTP Verb GET or POST URL rest method fieldpop api getUserDevices Query String Parameters happn_token Token obtained from login request List optional set to true to get array of deviceID stri...

Page 35: ...itted macAddress 00 50 56 C0 00 01 name oem unknown state Alarm packageInfo productName unknown customerName unknown productVersion unknown moduleVersions ae name smc field pop version 3 2 0 pe Build_...

Page 36: ...ur_MEc Example 4 JSON Response message Call successful data company SMC description http 192 168 100 180 deviceId thundercentaur_MEc location 18 766947 46 869106999999985 macAddress 00 50 4E 60 05 4E...

Page 37: ...st method fieldpop api listDevicesUsers Query String Parameters happn_token Token obtained from login request deviceID the IIoT gateway ID see Section 3 1 1 Example GET URL rest method fieldpop api ge...

Page 38: ...n eyJ0eXAiOi JKV1QiLC Example JSON Response message Call successful data FieldPoP account requested Please check your email for further action error null Example Error Response message Call failed dat...

Page 39: ...n request deviceID the IIoT gateway ID see Section 3 1 1 Example GET URL rest method fieldpop api getDeviceData happn_token eyJ0eXAiOiJKV1QiLC Example 3 JSON Payload parameters deviceID FB4CC9BD94ADE5...

Page 40: ...eviceID the IIoT gateway ID see Section 3 1 1 Example GET URL rest method fieldpop api getDeviceDataWithTime happn_token eyJ0eXAiOiJKV1QiLC Example 3 JSON Payload parameters deviceID FB4CC9BD94ADE5D E...

Page 41: ...ining the following fields o deviceID the IIoT gateway ID see Section 3 1 1 Example 1 GET URL rest method fieldpop api getDeviceFirmwareVersions happn_token eyJ0eXAiOiJKV1QiLC deviceID cyberspa rrow_N...

Page 42: ...login request Body Parameters JSON parameters object containing the following fields o deviceID the IIoT gateway ID see Section 3 1 1 o firmwareVersion the semantic versioning or semver of firmware to...

Page 43: ...2 The desired deviceAPIVersion should be specified as part of the request Example rest method fieldpop api getDeviceData happn_token eyJ0eXAiOiJKV1QiLC deviceAPIVersion 2 If JSON body parameters are...

Page 44: ...are some examples deviceDataLog curl v L https www fieldpop io rest method fieldpop api deviceDataLog deviceID enter device id here happn_token enter token here getDeviceData curl v L H Content Type a...

Page 45: ...er4 3 Click on the Composer tab 4 Click on the Parsed tab 5 Set the HTTP verb to GET from the dropdown menu and enter the following HTTPS address https www fieldpop io rest login username username pas...

Page 46: ...P response is logged on the left part of the window HTTP code 200 indicates the call is successful 8 Double click on the URL logged on the left side of the screen 9 Select the Inspector tab 10 Select...

Page 47: ...be passed to the RESTful service in JSON format 17 Click on the Execute button to make a POST request 18 Double click the URL logged 19 Click on the Inspectors tab 20 Select JSON to see the response i...

Page 48: ...NA Response message Logged in ok data token tokenvalue error null 3 4 2 Authenticate via POST Command Method POST URL https www fieldpop io rest login Request Header Content Type application json Requ...

Page 49: ...ick Forgot Password on the MSA Grid Login Screen Once the Password Reset Window appears enter the email address of the MSA Grid account and click Submit Then close the window that appears Click on the...

Page 50: ...eed between different OEMs and different enterprise users 5 1 1 PC to MSA Grid To browse MSA Grid via PC type the following into the internet browser www smccloud net port 80 and 443 5 1 2 FieldServer...

Page 51: ...1 5 1 3 Viewing the Certificate Open a web browser on the local PC and go to www smccloud net Move the cursor to the padlock icon next to the website address Click the padlock icon to open a dropdown...

Page 52: ...Grid RESTful API Start up Guide 52 Review the information and click the Certificate button Examine the certificate as needed NOTE To download the certificate click the Details tab and click the Copy...

Page 53: ...iginal identification marks have been removed or altered This Limited Warranty also will not apply to interconnecting cables or wires consumables or to any damage resulting from battery leakage In all...

Reviews:

No comments