GetRelatedLots request message
- Last UpdatedSep 06, 2023
- 2 minute read
This is an example of the full structure of a GetRelatedLots request.
< GetRelatedLotsRequest>
< Credentials/>
< Localization />
<StartingFilters>
<Value>
<Name>SampleDateTime</Name>
<Value> <= "Thursday, 20 June 2018 3:00:00 PM" And >; "Saturday, 22 June 2018 5:00:00 PM"</Value>
</Value>
<Value>
<Name>Material Model</Name>
<Value>"Material Model.Raw Coal"</Value>
</Value>
<Value>
<Name>Location</Name>
<Value>Enterprise.Site 2.Area 1.Raw Coal Storage</Value>
</Value>
<Value>
<NameLot</Name>
<Value></Value>
</Value>
<Value>
<Name>LotGroup</Name>
<Value></Value>
</Value>
</StartingFilters>
<ResultFilters/>
<Value>
<Name>SampleDateTime</Name>
<Value> </Value>
</Value>
<Value>
<Name>Material Model</Name>
<Value></Value>
</Value>
<Value>
<Name>Location</Name>
<Value></Value>
</Value>
<Value>
<NameLot</Name>
<Value>Lot695</Value>
</Value>
<Value>
<Name>LotGroup</Name>
<Value>LotGroup01</Value>
</Value>
</ResultFilters>
</ GetRelatedLotsRequest >
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: 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. |
Request parameters: StartingFilters section
Contains the sets of the starting filters.
<StartingFilters>
<Value>
<Name>Material Model</Name>
<Value>"Material Model.Raw Coal"</Value>
</Value>
<Value>
<Name>Location</Name>
<Value>Enterprise.Site 2.Area 1.Raw Coal Storage</Value>
</Value>
</StartingFilters>
|
Parameter |
Description |
|---|---|
|
FilterValue |
Contains the values of each individual starting filter. |
|
Name |
The name of a field to use as filtering option to identify lots. |
|
Value |
The value to use for the specified field in filtering the search results. |
Request parameters: ResultFilters section
Contains the sets of result filters. This value can be null, making the results filter optional.
<ResultFilters/>
<Value>
<NameLot</Name>
<Value>Lot695</Value>
</Value>
<Value>
<Name>LotGroup</Name>
<Value>LotGroup01</Value>
</Value>
</ResultFilters>
|
Parameter |
Description |
|
FilterValue |
Contains the values of each individual result filter. |
|
Name |
The name of a field to use as filtering option to identify lots. |
|
Value |
The value to use for the specified field in filtering the search results. |