GetReportRawData Functions
The GetReportRawData and GetReportRawDataSession functions return raw data for the specified report in the specified System file. These two functions differ only in respect to parameters for login. For more information, see Login Parameters.
 |
The GetReportRawData and GetReportRawDataSession functions are supported only for the FRACAS, FMEA, FTA, and Prediction modules.
|
Syntax
The following is the syntax for an HTTP request:
POST /POST /WindchillRiskandReliability12.0/DataEngine.asmx/GetReportRawData HTTP/1.1
Host: HostName
Content-Type: application/x-www-form-urlencoded
Content-Length: length
UserName=string&Password=string&GroupName=string&ProjectName=string
&SystemName=string&ReportName=string&ExtraParameter=string
&FilterParameters=string
Host: HostName
Content-Type: application/x-www-form-urlencoded
Content-Length: length
UserName=string&Password=string&GroupName=string&ProjectName=string
&SystemName=string&ReportName=string&ExtraParameter=string
&FilterParameters=string
Parameters
In addition to login parameters, both the GetReportRawData and GetReportRawDataSession functions use these parameters:
• ProjectName—The name of the Windchill Risk and Reliability Project. This value is case-sensitive.
• SystemName—The name of the System file. This value is case-sensitive.
• ReportName—The name of the report for which to get raw data. Any file in the Common Library must be prefixed with (Common).
• ExtraParameter—For a prediction report, the identifier of the configuration if needed. For an FMEA or FTA report, the identifier of the item for which to get raw data.
◦ For an FMEA report, you specify the identifier of the FMEA.
◦ For an FTA report, if you want to report on a specific top gate, you specify the identifier of the top gate. Otherwise, if no identifier is specified, all top gates are included in the report.
This parameter is not required for a FRACAS report.
• FilterParameters—The specific values that you want to use for the parameters required by an applied filter. If values are not specified, default values are used. To specify values, you must know the number and order of the required parameters. When passing values for multiple parameters, two colons (::) must separate each text string. You can see the required parameters in the Filter file in which the filter is stored. If passed values do not match or are unnecessary, they are ignored.
The following is an example of an HTTP POST request:
POST /POST /WindchillRiskandReliability12.0/DataEngine.asmx/GetReportRawData HTTP/1.1
Host: vm-test
Content-Type: application/x-www-form-urlencoded
Content-Length: length
UserName=Bill&Password=passwd&GroupName=Manager&ProjectName=Tablet PC &SystemName=Tablet PC&ReportName=(Common) FRACAS Failure Modes Summary
Host: vm-test
Content-Type: application/x-www-form-urlencoded
Content-Length: length
UserName=Bill&Password=passwd&GroupName=Manager&ProjectName=Tablet PC &SystemName=Tablet PC&ReportName=(Common) FRACAS Failure Modes Summary
Returns
If the user is authenticated and the required parameter values are found, raw data for the report is returned in the AdditionalData tag in JSON format. To easily read this data, paste it into a JSON validator.
<?xml version="1.0" encoding="utf-8"?>
<DataEngineResponse xmlns="http://tempuri.org/">
<Success>true</Success>
<AdditionalData>{Returned_Report_Data}</AdditionalData>
</DataEngineResponse>
<DataEngineResponse xmlns="http://tempuri.org/">
<Success>true</Success>
<AdditionalData>{Returned_Report_Data}</AdditionalData>
</DataEngineResponse>
If the call fails, the AdditionalData tag provides the reason for the failure.