UpdateRecordStatus request message
- Last UpdatedJun 02, 2024
- 2 minute read
This is an example of the full structure of an UpdateRecordStatus request.
<UpdateRecordStatusRequest>
<Credentials>
<Username>User</Username>
<Password>********</Password>
<Session />
</Credentials>
<UpdateRecordStatus>
<RecordStatus>
<Module>Production</Module>
<Location>EnterpriseFolder.SiteFolder1.Production1</Location>
<MergeCriteria>
<SetId>11257</SetId>
</MergeCriteria>
<RecordAction>Confirm</RecordAction>
<LocationIdentifier>Location1</LocationIdentifier>
<RequestOrigin>TestOrigin1</RequestOrigin>
</RecordStatus>
</UpdateRecordStatus>
</UpdateRecordStatusRequest>
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: UpdateRecordStatus section
Contains the set of records to update.
<UpdateRecordStatus>
<RecordStatus>
<Module>Production</Module>
<Location>EnterpriseFolder.SiteFolder1.Production1</Location>
<MergeCriteria>
<SetId>11257</SetId>
</MergeCriteria>
<RecordAction>Confirm</RecordAction>
<LocationIdentifier>Location1</LocationIdentifier>
<RequestOrigin>TestOrigin1</RequestOrigin>
</RecordStatus>
</UpdateRecordStatus>
|
Parameter |
Description |
|---|---|
|
RecordStatus |
An individual record to update that contains the Module and Location parameters. |
|
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) Maps to a folder location when navigating "by location." |
|
MergeCriteria |
Contains the information to identify the records to update. |
|
SetId |
Identifies the unique record to update. This parameter maps to the row.id returned by GetData. If you provide a SetID, no other information is required and the record updates. If you submit a new record, use ID=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. |