Page History

...

curl "http://localhost:8080/FewsWebServices/rest/fewspiservice/v1/warmstates?moduleInstanceId=moduleInstanceId1&stateTime=2020-03-18T15:00:00Z" 

GET /resources/static/{resourceId} (2023.01)

Get get a text resource from the PiClientConfigFiles folder

Path parameters

• resourceId (string): name of a resource in the PiClientConfigFiles config folder. Typically a css file or json file.

Response

• • binary with the content of the IconFile

Example request

curl "http://localhost:8080/FewsWebServices/rest/fewspiservice/v1/resources/static/style.css"

GET /resources/images/{resourceId} (2023.01)

Get get a resource from the IconFiles folder

Path parameters

• resourceId (string): name of a image file that is in the IconFiles config folder.

Response

• • binary with the content of the IconFiles

Example request

curl "http://localhost:8080/FewsWebServices/rest/fewspiservice/v1/resources/images/weboc_login_logo.png"

FEWS PI REST Web Service API - Embedded endpoints

...

• documentFormat (string): TEXT (default) or PI_JSON

Response

• • text response with the actual system time.  Format: yyyy-MM-ddTHH:mm:ssZ

Example request

curl "http://localhost:8080/FewsWebServices/rest/fewspiservice/v1/systemtime"

...

• documentFormat (string): TEXT (default) or PI_JSON

Response

• • text response with the last update time.  Format: yyyy-MM-ddTHH:mm:ssZ

Example request

curl "http://localhost:8080/FewsWebServices/rest/fewspiservice/v1/lastupdatetime"

...

• documentFormat (string): PI_JSON

Response

• • PI_JSON response

Example request

curl "http://localhost:8080/FewsWebServices/rest/fewspiservice/v1/topology/selected"

...

• documentFormat (string): PI_JSON

Response

• • PI_JSON response

Example request

curl "http://localhost:8080/FewsWebServices/rest/fewspiservice/v1/parameters/selected"

...

• documentFormat (string):  PI_JSON

Response

• • PI_JSON response

Example request

curl "http://localhost:8080/FewsWebServices/rest/fewspiservice/v1/filters/selected"

...

• documentFormat (string):  PI_JSON

Response

• • PI_JSON

Example request

curl "http://localhost:8080/FewsWebServices/rest/fewspiservice/v1/locations/selected"

...

• documentFormat (string): PI_XML (default) or PI_JSON
• topologyNodeId (string): Id of the topology node for which the time series will be returned.
• timeZero (date): time zero in format: yyyy-MM-ddTHH:mm:ssZ
• startTime (date): Optional startTime for the requested period in format: yyyy-MM-ddTHH:mm:ssZ. If not set, the start time of the zoom period in the first time series dialog will be used.
• endTime (date): Optional endTime for the requested period in format: yyyy-MM-ddTHH:mm:ssZ. If not set, the end time of the zoom period in the first time series dialog will be used.
• thresholdsVisible (boolean): Set to true to make thresholds visible.
• omitMissing (boolean): Toggle omitting or returning of missing values in response. Default is true
• useDisplayUnits (boolean): Set to true to use display units
• convertDatum (boolean): Set to true to convert datum
• documentVersion (string): Document Version

Response

• • Timeseries in PI_XML or PI_JSON format

Example request

curl "http://localhost:8080/FewsWebServices/rest/fewspiservice/v1/timeseries/topology/node"

...

GET the web OC Configuration

Response

• • JSON response with the Web OC configuration.

Example request

curl "http://localhost:8080/FewsWebServices/rest/fewspiservice/v1/weboc/configuration"

...

{
  "components": [
    {
      "type": "string",
      "title": "string"
    }
  ],
  "general": {
    "title": "string",
    "icons": {
      "logo": "string",
      "favicon": "string"
    }
  }
}

GET /weboc/resources (2023.01)

Get get a resource from the IconFiles folder

Request parameters

• resourceId (string): name of the resource in the IconFiles.

Response

• • binary with the content of the IconFile

Example request

curl "http://localhost:8080/FewsWebServices/rest/fewspiservice/v1/weboc/resources?resourceId=logo.png"

Example text response

GET /weboc/resources/public (2023.01)

Get get a resource from the IconFiles folder that is publicly available. No authentication is required.

Request parameters

• resourceId (string): One of: "weboc_login_logo.png","weboc_login_background.png"

Response

• • binary with the content of the IconFiles

Example request

curl "http://localhost:8080/FewsWebServices/rest/fewspiservice/v1/weboc/resources/public?resourceId=weboc_login_logo.png"

...