GetData request message

Context

(Required) The navigation context. At this time, the only valid value for Context is Plant.

Mode

(Required) The navigation mode. At this time, the only valid value for Mode is Location.

Module

(Required) Module maps to one of the standard AVEVA Production Management modules and names the specified module in the request. This can be any module, such as Downtime, Production, Inventory.

Name

The Name element defaults to <Module>.StandardView (and Metrics.AnalysisView for the Metrics module). This default behavior covers most standard queries. If an explicit value is provided, it overrides the default behavior. Module value is already provided by the Module element.

<Module>.<View>

For example, Downtime.StandardView or Inventory.BalanceByLot

For Quality reporting points, be sure to specify the correct view name for that type of Quality.

Fields

The Fields element is an array of Field names. This enables you to control the columns returned by the query. The values do not have to be XML encoded. This value is optional.

ModelFields

The ModelFields element is an array of model field names. Model Fields is an optional parameter that specifies which model item property to return and in what order.

To use this functionality, you have to set the Associated Model property of the reporting point field to the associated model type of the linked model item. The full name of the linked model item is specified in the Historical Expression property of the reporting point field.

The model fields are specified as a comma-delimited string with the dot between field associated with model item and name of the property of the model item: @ModelFields =’modelfield1.modelproperty1, modelfield2.modelproperty2’.

Use model fields if you want to get value of the model item property (modelproperty1, modelproperty2) associated with the reporting point field (modelfield1, modelfield2).

Location

(Required) Location maps to a AVEVA Production Management folder location when navigating "by location."

SamplePeriod

SamplePeriod is the datetime period component of a query folder.

Deleted

When this value is True, the deleted fields are included in results. Value can be True or False. Parameter is optional.

Criteria

The Criteria element is an array of custom filter values. Filters are specified with the use of the name/value principle. Parameter is optional.

FilterEntries

Contains the filter values for the returned data. For example: Name=Cause Value=BrokenPump filters the returned results to records with a Cause value of Broken Pump. Without filtering, the request returns all available data.

LocationIdentifier

The unique external identifier for AVEVA Production Management to recognize a reporting point or equipment from an external system. For example, an identifier from SAP for a reporting point. Must be a string value. Parameter is optional.

Metadata

When this value is True, the response includes Metadata. Value can be True or False. Parameter is optional.

ResolveIdentifiers

The ResolveIdentifiers element enables the request to resolve Cause and Classification identifiers to return the text values that correspond. The value is True or False.

ExcludeModuleSpecificMetadata

When value is True, any module specific metadata is excluded from the response. This element is available only for the Inventory module.

ExcludeSpecification

When value is True, any specification metadata is excluded from the response. This element is available only for the Inventory module.