Request parameters

SubmitDataRecord

An individual data record, containing the necessary information to submit when using AMQP protocol. When passing XML schema, it is necessary to use <Records> instead of <SubmitDataRecord>.

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.

Location

(Required) You provide the Location field. For most modules, this parameter specifies the exact reporting point that you are inserting into. Do not use the parent folder.

You can use different locations for different SubmitData records. In the case of Inventory, the location can be any movement configuration item, including the default AdhocMaterialMovement item or any Routine movement item in Studio. It can also be a dynamic material movement. In the case of an adjustment, the location is the relevant equipment.

RequestOrigin

This is an optional string value that determines the origin of the webservice request. This value can be checked as a property on the recordChangedEventArgs in code items to ensure the event wasn't triggered by the same origin to prevent infinite loops.

SetId

Identifies the unique record to update. This parameter maps to the row.id returned by GetData. If you provide an ID, no other information is required and the record updates.

If the record with the ID does not exist, AVEVA Production Management returns an error. If you don't know the SetId, you can find an existing record through the KeyFieldName filter. If a record cannot be found using the filter, AVEVA Production Management creates a new record.

To submit a new record, use ID=0

KeyFieldNames

Contains the set of key field names.

FieldName

The FieldNames element enables you to create filters to find existing records, when you do not know the SetId. This value matches a corresponding value below in the Field.Name element.