GetViews response message
- Last UpdatedAug 29, 2023
- 2 minute read
This is an example of the full structure of a GetViews response message.
<GetViewsResponse>
<Context>
<Context>Plant</Context>
<Mode>Location</Mode>
<Module>Downtime</Module>
<ViewPoint>Enterprise.Site1.Downtime1</ViewPoint>
<Localization />
</Context>
<Views>
<View name="Enterprise.Site1.Downtime1">
<DisplayName>Downtime1</DisplayName>
<LocalizedDisplayName>Downtime1</LocalizedDisplayName>
<AllowedOperations>
<AllowedOperation>
<Operation>AddRecord</Operation>
<Allowed>true</Allowed>
</AllowedOperation>
<AllowedOperation>
<Operation>DeleteRecord</Operation>
<Allowed>true</Allowed>
</AllowedOperations>
<Fields>
<Field name="HasAudit" type="xs:Boolean" displayName="HasAudit" localizedDisplayName="HasAudit" />
<Field name="CreatedBy" type="xs:String" displayName="CreatedBy" localizedDisplayName="CreatedBy" />
<Field name="IsManual" type="xs:Boolean" displayName="IsManual" localizedDisplayName="IsManual" />
<Field name="CreatedDateTime" type="xs:DateTime" displayName="CreatedDateTime" localizedDisplayName="CreatedDateTime" />
<Field name="ConfirmedBy" type="xs:String" displayName="ConfirmedBy" localizedDisplayName="ConfirmedBy" />
</Fields>
<Filters>
<Filter name="IsConfirmed" type="xs:Boolean" displayName="Confirmed" localizedDisplayName="Confirmed" />
<Filter name="IsDeleted" type="xs:Boolean" displayName="Deleted" localizedDisplayName="Deleted" />
<Filter name="IsMasked" type="xs:Boolean" displayName="Masked" localizedDisplayName="Masked" />
<Filter name="IsVirtual" type="xs:Boolean" displayName="Virtual" localizedDisplayName="Virtual" />
<Filter name="StartDateTime" type="xs:DateTime" displayName="Start Time" localizedDisplayName="Start Time" />
<Filter name="EndDateTime" type="xs:DateTime" displayName="End Time" localizedDisplayName="End Time" />
<Filter name="LocationIdentifier" type="xs:String" displayName="Location Identifier" localizedDisplayName="Location Identifier" />
</Filters>
<Periods>
<Period name="Hour" displayName="Hour" localizedDisplayName="Hour" />
<Period name="15 Minutes" displayName="15 Minutes" localizedDisplayName="15 Minutes" />
</Periods>
</View>
</Views>
</GetViewsResponse>
Response parameters: Context section
Reports the context and location of the original request.
|
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. Only the Downtime and Energy modules support splitting records. |
|
ViewPoint |
The viewpoint specified in the request. This is the location of the view in the AVEVA Production Management hierarchy. For example, EnterpriseFolder.SiteFolder1. |
Response 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. |
Response parameters: Views section
The Views section contains the returned values that describe the queried view.
<Views>
<View name="Enterprise.Site1.Downtime1">
<DisplayName>Downtime1</DisplayName>
<LocalizedDisplayName>Downtime1</LocalizedDisplayName>
<AllowedOperations>
<AllowedOperation>
<Operation>AddRecord</Operation>
<Allowed>true</Allowed>
</AllowedOperation>
|
Parameter |
Description |
|---|---|
|
View |
The name of the view. For example, Enterprise.Site1.Downtime1. |
|
DisplayName |
The display name of the view. |
|
LocalizedDisplayName |
The localized display name of the view. |
|
AllowedOperations |
Contains the subsets of AllowedOperations. |
|
AllowedOperation |
The AllowedOperation set contains the Operation and Allowed parameters. |
|
Operation |
The name of the operation that may be performed. Any valid AVEVA Production Management operation. For example, AddRecord, ViewRecord. |
|
Allowed |
States whether it is allowed: True or False. |
Response parameters: Fields section
Contains the set of fields.
<Fields>
<Field name="HasAudit" type="xs:Boolean" displayName="HasAudit" localizedDisplayName="HasAudit" />
<Field name="CreatedBy" type="xs:String" displayName="CreatedBy" localizedDisplayName="CreatedBy" />
<Field name="IsManual" type="xs:Boolean" displayName="IsManual" localizedDisplayName="IsManual" />
<Field name="CreatedDateTime" type="xs:DateTime" displayName="CreatedDateTime" localizedDisplayName="CreatedDateTime" />
<Field name="ConfirmedBy" type="xs:String" displayName="ConfirmedBy" localizedDisplayName="ConfirmedBy" />
</Fields>
|
Parameter |
Description |
|---|---|
|
Field |
Each field contains "name", "type", "displayName", and "localizedDisplayName". Each field may also contain "readonly", "required", hasAllowedValues", and "hasRelationshipMatrixValues". The default value when fields are absent is False. |
Response parameters: Filters section
The Filters section contains the set of filters.
<Filters>
<Filter name="IsConfirmed" type="xs:Boolean" displayName="Confirmed" localizedDisplayName="Confirmed" />
<Filter name="IsDeleted" type="xs:Boolean" displayName="Deleted" localizedDisplayName="Deleted" />
</Filters>
|
Parameter |
Description |
|---|---|
|
Filter |
Each filter contains "name", "type", "displayname" and "localizedDisplayName." |
Response parameters: Periods section
The Periods section contains the set of periods.
|
Parameter |
Description |
|---|---|
|
Period |
Each period contains "name", "displayname" and "localizedDisplayName." |