DeleteRecords request message
- Last UpdatedAug 29, 2023
- 2 minute read
This is an example of the full structure of a DeleteRecords request.
<DeleteRecordsRequest>
<Credentials>
<Username>User</Username>
<Password>********</Password>
<Session />
</Credentials>
<DeleteRecords>
<DeleteRecord>
<Module>Production</Module> <Location>EnterpriseFolder.SiteFolder1.Production1</Location>
<MergeCriteria>
<SetId>11257</SetId>
</MergeCriteria>
<LocationIdentifier>Location1</LocationIdentifier>
</DeleteRecord>
</DeleteRecords>
</DeleteRecordsRequest>
Request parameters: Credentials section
The Credentials section contains the security details for authentication. You can provide the Username and Password values to use the Basic security method. If you do not provide explicit security values, Web services will attempt to use Integrated authentication. You must provide either Basic credentials, Integrated credentials, or a Session ID.
<Credentials>
<Username>User</Username>
<Password>********</Password>
<Session />
</Credentials>
|
Parameter |
Description |
|---|---|
|
Username |
The login name of the AVEVA™ Production Management user. This is a string value. Username and Password together are mutually exclusive with Session. |
|
Password |
The password that is associated with the AVEVA Production Management user. This is a string value. Username and Password together are mutually exclusive with Session. |
|
Session |
A GUID string value that identifies the session. This is a string value. Mutually exclusive with Username and Password. |
Request parameters: DeleteRecords section
The DeleteRecords section contains the set of records to delete.
<DeleteRecord>
<Module>Production</Module>
<Location>EnterpriseFolder.SiteFolder1.Production1</Location>
<MergeCriteria>
<SetId>11257</SetId>
</MergeCriteria>
<LocationIdentifier>Location1</LocationIdentifier>
</DeleteRecord>
|
Parameter |
Description |
|---|---|
|
DeleteRecord |
Contains the details of an item property. |
|
Module |
Module is a mandatory element. Module maps to one of the standard AVEVA Production Management modules and names the specified module in the request. This can be any module, such as Downtime, Production, Inventory. |
|
Location |
(Required) Maps to a folder location when navigating "by location." |
|
Merge Criteria |
Contains the information to identify the records to delete. |
|
SetId |
Identifies the unique record to update. The SetId maps to the row.id returned by Get Data. If you provide a SetID, no other information is required and the record updates. |
|
LocationIdentifier |
The unique identifier for the reporting point from an external system. For example, an identifier from SAP for a reporting point. This is a string value. This parameter is optional. |