SplitRecords request message
- Last UpdatedJun 02, 2024
- 2 minute read
This is an example of the full structure of a SplitRecords request.
<SplitRecordsRequest>
<Credentials/>
<OriginalRecord>
<Module>Downtime</Module>
<Location>Enterprise.Site.Area.Point</Location>
<SetId>101</SetId>
<LocationIdentifier>Location1</LocationIdentifier>
<RequestOrigin>TestOrigin1</RequestOrigin>
</OriginalRecord>
<SplitRecords>
<SplitRecord>
<SplitDateTimeUtc>2018-04-29T13:00:00Z</SplitDateTimeUtc>
<FieldUpdates/>
<Field>
<Name>Classification</Name>
<Value>Unplanned</Value>
</Field>
<Field>
<Name>Cause</Name>
<Value>Foreign Obstacle</Value>
</Field>
</FieldUpdates>
</SplitRecord>
<SplitRecord>
<SplitDateTimeUtc>2018-04-29T13:30:00Z</SplitDateTimeUtc>
<FieldUpdates>
<Field>
<Name>Classification</Name>
<Value>Scheduled</Value>
</Field>
<Field>
<Name>Cause</Name>
<Value>Driver Swap</Value>
</Field>
</FieldUpdates>
</SplitRecord>
</SplitRecords>
</SplitRecordsRequest>
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: OriginalRecord section
Contains details about the original record.
<OriginalRecord>
<Module>Downtime</Module>
<Location>Enterprise.Site.Area.Point</Location>
<SetId>101</SetId>
<LocationIdentifier>Location1</LocationIdentifier>
<RequestOrigin>TestOrigin1</RequestOrigin>
</OriginalRecord>
|
Parameter |
Description |
|---|---|
|
Module |
(Required) Module maps to a standard AVEVA Production Management module. Only the Downtime and Energy modules support splitting records. |
|
Location |
(Required) The full reporting point location of the original record. |
|
SetId |
(Required) Identifies the unique record to update. This property maps to the row.id returned by GetData. A numerical value greater than zero (0). |
|
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. |
|
RequestOrigin |
Prevents infinite loops in requests by determining the original caller. |
Request parameters: SplitRecords section
Contains the set of split record data. At least one split record is required.
<SplitRecords>
<SplitRecord>
<SplitDateTimeUtc>2010-04-29T13:00:00Z</SplitDateTimeUtc>
<FieldUpdates/>
<Field>
<Name>Classification</Name>
<Value>Unplanned</Value>
</Field>
</FieldUpdates>
</SplitRecord>
|
Parameter |
Description |
|
SplitRecord |
Contains split record details. |
|
SplitDateTimeUtc |
(Required) The date and time in UTC format when the original record is split. |
|
FieldUpdates |
Contains a set of field updates. |
|
Field |
Contains details about a field to update. |
|
Name |
The name of the field. |
|
Value |
The value in the field. |