GetAllowedValues request message
- Last UpdatedAug 29, 2023
- 1 minute read
This is an example of the structure of a GetAllowedValues request.
<GetAllowedValuesRequest>
<Credentials>
<Username>User</Username>
<Password>********</Password>
<Session />
</Credentials>
<Module>Downtime</Module>
<Location>Enterprise.Site1.Downtime1</Location>
<Fields />
<LocationIdentifier>Location1</LocationIdentifier>
</GetAllowedValuesRequest>
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: GetAllowedValuesRequest section
<GetAllowedValuesRequest>
<Module>Downtime</Module>
<Location>Enterprise.Site1.Downtime1</Location>
<Fields />
<LocationIdentifier>Location1</LocationIdentifier>
</GetAllowedValuesRequest>
|
Parameter |
Description |
|---|---|
|
Module |
Module maps to one of the standard AVEVA™ Production Management modules. In this case, only Downtime and Energy apply. |
|
Location |
The location must specify a reporting point. There is no recurse. If the location is not specified, the method returns fields with AllowedValues. |
|
Fields |
The names of the fields being queried for allowed values. |
|
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. |