DeleteRecord Functions
The DeleteRecord and DeleteRecordSession functions delete a specified record from a table. These two functions differ only in respect to parameters for login. For more information, see Login Parameters.
If the table where the record is located is a tree structure, then all child records are also deleted. This means that the entire branch is removed.
In the FTA module, a record can be a trigger event input to a functional dependency gate or a conditional event input to an inhibit gate. Deleting such a record deletes the related gate, along with all child records.
Syntax
The following is the syntax for an HTTP request:
POST /WindchillRiskandReliability12.0/DataEngine.asmx/DeleteRecord 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
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
Parameters
In addition to login parameters, both DeleteRecord and DeleteRecordSession 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 delete. 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 required for the FMEA Worksheet and List Choices tables. It is also used if you are deleting a repeated event. 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.
◦ For a repeated event, the identifier of the gate to which the repeated event belongs when specifying the identifier of a repeated event to delete. If the same event is repeated under a single parent, the first one found by the API is deleted.
The following is an example of an HTTP POST request:
POST /WindchillRiskandReliability12.0/DataEngine.asmx/DeleteRecord
HTTP/1.1Host: 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=System25
HTTP/1.1Host: 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=System25
Returns
If the user is authenticated and the specified parameter values are found, the record is deleted 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.