To retrieve a specific report use the WSXF action with the report's unique identifier (Guid):
https://your-server-address/wats/api/report/wsxf/ABCDEF01-2345-6789-ABCD-EF0123456789
The report guid can be found using the query method (see https://virinco.zendesk.com/hc/en-us/articles/207424243 )
Refer to https://virinco.zendesk.com/hc/en-us/articles/207424643 for details on the WSXF format.
Query Parameters
detailLevel (integer, 0-7, default: 7)
You can reduce the amount of data returned by specifying detail level in the request. The detail level is an integer between 0 and 7, where 0 is report identification values only, and 7 is all available data including binary data like attachments and chartdata.
It is recommended to use as low detaillevel as possible to increase performance and reduce the workload and datatransfer.
| Level | Name | Description |
| 0 | Report identification | Report identifying data (Type,ID,PN,SN,StartUTC and Process-code) |
| 1 | Header data | All report header data only, excluding subparts and miscinfo |
| 2 | Header related | All report header data only, including subparts and miscinfo |
| 3 | Root step | Root-step, including sequence info |
| 4 | Step data | All steps, but no measurements |
| 5 | undefined | - |
| 6 | Measurements | All step data and measurements, excluding plotdata |
| 7 | Full report | All step data and measurements, including plotdata |
includeAttachments (boolean, default: true)
Specify if attachment data should be included in the report. Set to false to suppress attachment data for detail levels 4-7.
includeChartdata (boolean, default: true)
Specify if chart data (plots) should be included in the report. Set to false to suppress plot data for detail levels 6-7.
includeIndexes (boolean, default: true)
Specify if indexes should be included in the report. Set to false to suppress internal database indexes (Idx, MeasIndex, StepIndex, etc.).
Example
https://your-server-address/wats/api/report/wsxf/ABCDEF01-2345-6789-ABCD-EF0123456789?detailLevel=2
returns headerdata, subpart and miscinfo for the given report id.
Return full report without attachments, chart data and indexes for a given report id
Comments
0 comments
Please sign in to leave a comment.