GetAuditData response message
- Last UpdatedAug 29, 2023
- 2 minute read
This is an example of the structure of a GetAuditData response message.
<GetAuditDataResponse>
<Context>
<Filter>
<Module>Downtime</Module>
<Location>Company.Plant.Machinery</Location>
<SetId />
<EditedBy />
<EditedSamplePeriod>
<Name>SampleDateTime</Name>
<Start>2009-04-30T16:00:00Z</Start>
<End>2009-05-31T16:00:00Z</End>
</EditedSamplePeriod>
</Filter>
<Localization />
</Context>
<RowSets>
<RowSet>
<Rows>
<Row>
<SetId>5444</SetId>
<EditedBy>System Configuration.Users.Username</EditedBy>
<EditedDateTime>2009-02-09T23:07:17Z</EditedDateTime>
<Location>Company.Plant.Machinery</Location>
<Field>Cause Location</Field>
<OriginalValue>191</OriginalValue>
<EditedValue>196</EditedValue>
</Row>
</Rows>
</RowSet>
</RowSets>
</GetAuditDataResponse>
Response parameters: Context section
Reports the context and location of original request.
<Context>
<Filter>
<Module>Downtime</Module>
<Location>Company.Plant.Machinery</Location>
<SetId />
<EditedBy />
<EditedSamplePeriod>
<Name>SampleDateTime</Name>
<Start>2009-04-30T16:00:00Z</Start>
<End>2009-05-31T16:00:00Z</End>
</EditedSamplePeriod>
</Filter>
<Localization />
</Context>
|
Parameter |
Description |
|---|---|
|
Filter |
Contains the filter values specified in the original request. |
|
Module |
Returns one of the standard AVEVA™ Production Management modules. |
|
Location |
(Required) Maps to a folder location when navigating "by location." |
|
SetId |
Returns the SetId of the specific record that was updated. This is a unique identifier for the record. The SetId maps to the row.id returned by Get Data. It is a numeric value. When a record is edited, this is the ID for the specified record. When new records are inserted, this is a new ID for created records. For movements, the SetId is 0 (zero). |
|
EditedBy |
Specifies the AVEVA Production Management user who last edited the record. |
|
EditedSamplePeriod |
The details of the edited sample period. |
|
Name |
The name of the edited sample period. |
|
Start |
The start time of the edited sample period. |
|
End |
The end time of the edited sample period. |
Response parameters: Localization section
The Localization section contains parameters that are relevant to localizing the data for display.
<Localization>
<Language>fr-FR</Language>
< /Localization>
|
Parameter |
Description |
|---|---|
|
Language |
The Windows regional setting to determine the language display of data in the client. This can be any Windows regional setting value, for example, en-AU, en-GB, fr-FR. If no language is specified, the default en-US is used. |
Response parameters: Rows section
Contains the returned audit data for each row.
<Row>
<SetId>5444</SetId>
<EditedBy>System Configuration.Users.Username</EditedBy>
<EditedDateTime>2009-02-09T23:07:17Z</EditedDateTime>
<Location>Company.Plant.Machinery</Location>
<Field>Cause Location</Field>
<OriginalValue>191</OriginalValue>
<EditedValue>196</EditedValue>
</Row>
|
Parameter |
Description |
|---|---|
|
SetId |
Returns the SetId of the audited record. |
|
EditedBy |
Specifies the AVEVA Production Management user who last edited the record. |
|
EditedDateTime |
The date and time details when the record was edited. |
|
Location |
Returns the location of the record. |
|
Field |
Returns the name of the edited field. |
|
OriginalValue |
Returns the original value of the field. |
|
EditedValue |
Returns the edited value of the field. |