GetReprocessingHistory request message
- Last UpdatedSep 06, 2023
- 2 minute read
This is an example of the full structure of a GetReprocessingHistory request.
<GetReprocessingHistoryRequestMessage xmlns="http://www.citect.com/Ampla/Inventory/2010/03">
<GetReprocessingHistoryRequestMessage>
<Request>
<Credentials>
<Password>********</Password>
<Session />
<Username>User</Username>
</Credentials>
<Filter>
<State>Any</State>
<TopN>2</TopN>
<FullOnly>False</FullOnly>
</Filter>
<Localization>
<Language>fr-FR</Language>
<Localization>
</Request>
</GetReprocessingHistoryRequestMessage>
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
<Filter>
<State>Any</State>
<TopN>2</TopN>
<FullOnly>False</FullOnly>
</Filter>
|
Parameter |
Description |
|---|---|
|
State |
Applies a filter to returned reprocessing operations based on the current state: Any, Running, Failed, Canceled, Completed. When State is set to Any, the query will return all history items, regardless of state. This will include records with states Canceled and Failed. |
|
TopN |
Enables you to specify the N number of reprocessing operations (going backwards in time from the present). For example, the last 2 reprocessing operations. Returns the latest N reprocessing operations, from most recent to oldest. If specified N is greater than number of history items available, then all history is returned. If never there has never been a reprocessing, no data is returned. |
|
FullOnly |
A boolean filter. If set to True, the full reprocessing history is returned. |
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. |