GetAllowedValues response message
- Last UpdatedAug 29, 2023
- 1 minute read
This is an example of the full structure of a GetAllowedValues response message.
<GetAllowedValuesResponse>
<Context>
<Module>Downtime</Module>
<Location>Enterprise.Site1.Downtime1</Location>
<Fields />
</Context>
<AllowedValueFields>
<AllowedValueField>
<Field>Cause Location</Field>
<AllowedValues>
<AllowedValue>Enterprise.Site1</AllowedValue>
</AllowedValues>
</AllowedValueField>
</AllowedValueFields>
</GetAllowedValuesResponse>
Response parameters: Context section
Reports the context and location of original request.
<Context>
<Module>Downtime</Module>
<Location>Enterprise.Site1.Downtime1</Location>
<Fields />
</Context>
|
Parameter |
Description |
|---|---|
|
Module |
Returns the module specified in the request. In this case, only Downtime and Energy apply. |
|
Location |
Returns the location specified in the request. For example, Enterprise.Site1.Downtime1. |
|
Fields |
Returns the fields specified in the request. |
Response parameters: AllowedValueFields section
Contains the subsets of AllowedValueFields.
<AllowedValueFields>
<AllowedValueField>
<Field>Cause Location</Field>
<AllowedValues>
<AllowedValue>Enterprise.Site1</AllowedValue>
</AllowedValues>
</AllowedValueField>
</AllowedValueFields>
|
Parameter |
Description |
|---|---|
|
AllowedValueField |
The AllowedValueField contains the Field and AllowedValue parameters. |
|
Field |
The name of the field that is being queried for allowed values. For example, Cause Location. |
|
AllowedValues |
Contains the allowed values for the queried field. |
|
AllowedValue |
Specifies an allowed value. |