...
| Code Block |
|---|
curl "http://localhost:8080/FewsWebServices/rest/fewspiservice/v1/warmstates?moduleInstanceId=moduleInstanceId1&stateTime=2020-03-18T15:00:00Z" |
GET resources/static/{path}/{resourceId} (2023.
...
02)
Get a text static web resource from the PiClientConfigFiles WebResources folder. Only the file name (resource id) will be Typically used to resolve the resource. If you have a file with name test.css in one of your folders then any query with file name test.css will have this test.css returned.provide static resources to the Web OC.
Path parameters
- path (string, optional): One or more subfolders. Note that this path will not be used to resolve the resource. Only the resourceId will be used.
- resourceId (string, required): name of a resource in the PiClientConfigFiles WebResources config folder. Typically a css file or json file name
Response
- binary with the The content of the IconFileresource.
Example request
| Code Block |
|---|
curl "http://localhost:8080/FewsWebServices/rest/fewspiservice/v1/resources/static/style.css" |
GET resources/images/{path|/{resourceId} (2023.01)
Get a resource from the IconFiles folder. Only the file name (resource id) will be used to resolve the resource. If you have a file with name test.png in one of your folders then any query with file name test.png will have this test.png returned.
Path parameters
- path (string, optional): One or more subfolders. Note that this path will not be used to resolve the resource. Only the resourceId will be used.
- resourceId (string): name of a image file that is in the IconFiles config folder.
Response
- binary with the content of the IconFiles
Example request
| Code Block |
|---|
curl "http://localhost:8080/FewsWebServices/rest/fewspiservice/v1/resources/images/weboc_login_logo.png" |
GET displaygroups/plot (2023.01)
...
- documentFormat (string): TEXT (default) or PI_JSON
Response
- text response with the actual system time. Format: yyyy-MM-ddTHH:mm:ssZ
Example request
| Code Block |
|---|
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
| Code Block |
|---|
curl "http://localhost:8080/FewsWebServices/rest/fewspiservice/v1/lastupdatetime" |
...
- documentFormat (string): PI_JSON
Response
- PI_JSON response
Example request
| Code Block |
|---|
curl "http://localhost:8080/FewsWebServices/rest/fewspiservice/v1/topology/selected" |
...
- documentFormat (string): PI_JSON
Response
- PI_JSON response
Example request
| Code Block |
|---|
curl "http://localhost:8080/FewsWebServices/rest/fewspiservice/v1/parameters/selected" |
...
- documentFormat (string): PI_JSON
Response
- PI_JSON response
Example request
| Code Block |
|---|
curl "http://localhost:8080/FewsWebServices/rest/fewspiservice/v1/filters/selected" |
...
- documentFormat (string): PI_JSON
Response
- PI_JSON
Example request
| Code Block |
|---|
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
| Code Block |
|---|
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
| Code Block |
|---|
curl "http://localhost:8080/FewsWebServices/rest/fewspiservice/v1/weboc/configuration" |
...