ReadSamples request message
- Last UpdatedOct 10, 2024
- 2 minute read
This is an example of the structure of a ReadSamples request.
<ReadSamplesRequestMessage xmlns="http://www.citect.com/Ampla/RuntimeData/2008/04">
<Request>
<Credentials>
<Password>********</Password>
<Session xsi:nil="true" />
<Username>Administrator</Username>
</Credentials>
<End>2018-08-18T01:30:00</End>
<ItemPropertyNames>
<ItemPropertyNames>
<ItemFullName>Material Movements.MaterialMovementItem</ItemFullName>
<PropertyName>Captures</PropertyName>
</ItemPropertyNames>
</ItemPropertyNames>
<Start>2018-08-18T00:30:00</Start>
</Request>
</ReadSamplesRequestMessage>
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: ItemPropertyNames section
Contains the set of item property names.
<End>2018-08-18T01:30:00</End>
<ItemPropertyNames>
<ItemPropertyNames>
<ItemFullName>Material Movements.MaterialMovementItem</ItemFullName>
<PropertyName>Captures</PropertyName>
</ItemPropertyNames>
</ItemPropertyNames>
<Start>2018-08-18T00:30:00</Start>
|
Parameter |
Description |
|---|---|
|
End |
(Required) The end date time of the data stream query. For example, 2018-08-24T18:00:00Z. |
|
ItemPropertyNames |
Contains the set of item property names. |
|
ItemPropertyNames |
Contains the details of an item property. |
|
ItemFullName |
(Required) The full name of the AVEVA™ Production Management item. |
|
PropertyName |
(Required) The name of the AVEVA Production Management property that provides the data stream. For example, DowntimeOffEvents, DowntimeOnEvents, RealDowntimeStates. |
|
Start |
(Required) The start date time of the data stream query. For example, 2018-08-24T12:00:00Z. |