GetViews request message
- Last UpdatedFeb 18, 2025
- 2 minute read
This is an example of the full structure of a GetViews request message.
<GetViewsRequest>
<Credentials>
<Username>User</Username>
<Password>********</Password>
<Session />
</Credentials>
<Context>Plant</Context>
<Mode>Location</Mode>
<Module>Production</Module>
<ViewPoint>EnterpriseFolder.SiteFolder1</ViewPoint>
<Localization>
<Language>en-US</Language>
</Localization>
</GetViewsRequest>
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: Context section
Reports the context and location of the original request.
<Context>Plant</Context>
<Mode>Location</Mode>
<Module>Production</Module>
<ViewPoint>EnterpriseFolder.SiteFolder1</ViewPoint>
|
Parameter |
Description |
|---|---|
|
Context |
Returns the navigation context. |
|
Mode |
Returns the navigation mode. Location, Cause Location, Product. |
|
Module |
Returns the AVEVA Production Management module specified in the request. This can be any AVEVA Production Management module. For example, Energy, Cost, Downtime, Knowledge, Maintenance, Metrics, Planning, Production, Quality, Recipe. |
|
ViewPoint |
The viewpoint specified in the request. This is the location of the view in the AVEVA Production Management hierarchy. For example, EnterpriseFolder.SiteFolder1. |
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. |