EditRecord Functions
The following functions modify the values of one or more fields in a specified table:
• EditRecord—Modifies the value of a field in the specified table.
• EditRecordSession—Modifies the value of a field in the specified table using a session token returned by the GetSessionToken function.
• EditRecordMultipleValues—Accepts a list of fields to read back from the record that you just modified. This allows you to read out a record that user calculations or FRACAS lookups modified in only one step.
• EditRecordMultipleValuesSession—Accepts a list of fields to read back from the record that you just modified using a session token returned by the GetSessionToken function.
 |
Because modifying values for multiple fields 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 EditRecord function:
POST /WindchillRiskandReliability12.0/DataEngine.asmx/EditRecord 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&Table=string&Identifier=string&AdditionalIdentifier=string&FieldName=string&FieldValue=string
Host: HostName
Content-Type: application/x-www-form-urlencoded
Content-Length: length
UserName=string&Password=string&GroupName=string&ProjectName=string&SystemName=string&Table=string&Identifier=string&AdditionalIdentifier=string&FieldName=string&FieldValue=string
Parameters
The EditRecord and EditRecordMultipleValues functions use the login parameters for Windchill Risk and Reliability user accounts. The EditRecordSession and EditRecordMultipleValuesSession functions use the single login parameter for sessions. For more information, see Login Parameters.
In addition to login parameters, all EditRecord 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.
• Table—The name of the Windchill Risk and Reliability table in which the record is located. This value is case-sensitive.
• Identifier—The identifier of the record that you want to modify. This value is not case-sensitive.
|
|
For the List Definition and List Choices tables, the identifier refers to the Display Text field.
|
• AdditionalIdentifier—The second identifier of the record that you want to modify. This parameter is only required for the FMEA Worksheet and List Choices tables. This value is not case-sensitive.
◦ For the FMEA Worksheet table, the value is the level of the FMEA data. Depending on your FMEA data structure, this can be one of the following. Item, Mode, Cause, Effect, or Action. If custom labels are assigned to data levels in the properties for the Project’s FMEA Design file, you can also use these values.
◦ For the List Choices table, the value is that in the Display Text field for the parent List Definition record.
|
|
If you cannot modify a field in the System file, you cannot modify it through the DataEngine API. For example, the Model field in the FTA Table is available for a basic event but not for an OR gate. The logic for the FTA module is especially complex and often requires user interaction. Consequently, you cannot use the DataEngine API to modify the following fields: Gate/Event type, Parent, and RecordNumber.
|
The following is an example of an HTTP POST request for the EditRecord function:
POST /WindchillRiskandReliability12.0/DataEngine.asmx/EditRecord 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&Table=System Tree Items&Identifier=A1&FieldName= Manufacturer&FieldValue=Superior Power Devices
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&Table=System Tree Items&Identifier=A1&FieldName= Manufacturer&FieldValue=Superior Power Devices
Returns
If the user is authenticated and the specified parameter values are found, the new field value is inserted and ‘true’ is returned.
<?xml version="1.0" encoding="utf-8"?>
<DataEngineResponse xmlns="http://tempuri.org/">
<Success>true</Success>
</DataEngineResponse>
<DataEngineResponse xmlns="http://tempuri.org/">
<Success>true</Success>
</DataEngineResponse>
If the call fails, the AdditionalData tag provides the reason for the failure.
Specifying Multiple Values
The EditRecordMultipleValues and EditRecordMultipleValuesSession functions are among those that use the FieldList parameter to specify multiple fields. For this function, you can update only one table at time. For more information, see Multiple Field Requests.