GetAuditData request message
- Last UpdatedAug 29, 2023
- 2 minute read
This is an example of the structure of a GetAuditData request.
<GetAuditDataRequest>
<Credentials>
<Username>User</Username>
<Password>********</Password>
<Session />
</Credentials>
<Filter>
<Module>Downtime</Module>
<Location>Company.Plant.Machinery</Location>
<SetId />
<EditedBy />
<EditedSamplePeriod>Current Month</EditedSamplePeriod>
<LocationIdentifier>Location1</LocationIdentifier>
</Filter>
<Localization />
</GetAuditDataRequest>
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: Filter section
Contains the set of filter parameters.
<Filter>
<Module>Downtime</Module>
<Location>Company.Plant.Machinery</Location>
<SetId />
<EditedBy />
<EditedSamplePeriod>Current Month</EditedSamplePeriod>
<LocationIdentifier>Location1</LocationIdentifier>
</Filter>
|
Parameter |
Description |
|---|---|
|
Module |
(Required) 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." |
|
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. If you submit a new record, use ID=0. |
|
EditedBy |
The name of a valid AVEVA Production Management user in this project. |
|
EditedSamplePeriod |
The SamplePeriod that applies to EditedBy. This is the date and time of the sample in the following format: YYYY-MM-DD T HH:MM:SS Z. T=Time and Z=UTC time format. If you leave this value empty, the current datetime is used. |
|
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. |
|
RecordType |
To return audit data for a lot or lot group record, you need to specify the record type as Lot or Lot Group. |
Request 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. |