ReadLookupRecord Functions
The following functions return the value of one or more fields for an existing record in the specified FRACAS Lookup Table file.
• ReadLookupRecord—Returns the value of a field for the record in the specified table.
• ReadLookupRecordSession—Returns the value of a field as described in the previous bullet using a session token returned by the GetSessionToken function.
• ReadLookupRecordMultipleValues—Accepts a list of fields to read back from the record. This allows you to read out a record that user calculations or FRACAS lookups modified in only one step.
• ReadLookupRecordMultipleValuesSession—Accepts a list of fields to read back from the record using a session token returned by the GetSessionToken function.
 |
Because returning values for multiple fields in multiple tables is complex, these functions are not usable from the dataengine.asmx test page on the server. When you click one of these functions, only a function description is shown.
|
Syntax
The following is the syntax for an HTTP request using the ReadLookupRecord function:
POST /WindchillRiskandReliability12.0/DataEngine.asmx/ReadLookupRecord HTTP/1.1
Host: HostName
Content-Type: application/x-www-form-urlencoded
Content-Length: length
UserName=string&Password=string&GroupName=string&ProjectName=string&LookupFileName=string&Key1=string&Key2=string&Key3=string&Key4=string&Key5=string
Host: HostName
Content-Type: application/x-www-form-urlencoded
Content-Length: length
UserName=string&Password=string&GroupName=string&ProjectName=string&LookupFileName=string&Key1=string&Key2=string&Key3=string&Key4=string&Key5=string
Parameters
The ReadLookupRecord and ReadLookupRecordMultipleValues functions use the login parameters for Windchill Risk and Reliability user accounts. The ReadLookupRecordSession and ReadLookup RecordMultipleValuesSession functions use the single login parameter for sessions. For more information, see Login Parameters.
In addition to login parameters, all ReadLookupRecord functions use these parameters:
• ProjectName—The name of the Windchill Risk and Reliability Project. This value is case-sensitive.
• LookupFileName—The name of the FRACAS Lookup Table file. This value is case-sensitive.
• Key1—The name of the first key field. This value is case-sensitive.
• Key2—The name of the second key field. This value is case-sensitive.
• Key3—The name of the third key field. This value is case-sensitive.
• Key4—The name of the fourth key field. This value is case-sensitive.
• Key5—The name of the fifth key field. This value is case-sensitive.
• FieldName—The name of the field in the FRACAS Lookup Table file from which you want data returned. This value is case-sensitive.
The following is an example of an HTTP POST request using the ReadLookupRecord function:
POST /WindchillRiskandReliability12.0/DataEngine.asmx/ReadLookupRecord 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 &LookupFileName=FRACAS Lookup Table 1&Location=Hanscom AFB&FieldName=Contact
Host: vm-test
Content-Type: application/x-www-form-urlencoded
Content-Length: length
UserName=Bill&Password=passwd&GroupName=Manager&ProjectName=Tablet PC &LookupFileName=FRACAS Lookup Table 1&Location=Hanscom AFB&FieldName=Contact
Returns
If the user is authenticated and the specified parameter values are found, the display value of the requested field is returned.
<?xml version="1.0" encoding="utf-8"?>
<DataEngineResponse xmlns="http://tempuri.org/">
<Success>true</Success>
<AdditionalData>John Smith</AdditionalData>
</DataEngineResponse></DataEngineResponse>
<DataEngineResponse xmlns="http://tempuri.org/">
<Success>true</Success>
<AdditionalData>John Smith</AdditionalData>
</DataEngineResponse></DataEngineResponse>
If the call fails, the AdditionalData tag provides the reason for the failure.
Specifying Multiple Values
The ReadLookupRecordMultipleValues and ReadLookupRecordMultipleValuesSession functions are among those that use the FieldList parameter to specify multiple fields. For more information, see Multiple Field Requests.