GetRelationshipMatrixValues request message
- Last UpdatedAug 29, 2023
- 2 minute read
This is an example of the full structure of a GetRelationshipMatrixValues request.
<GetRelationshipMatrixValuesRequest>
<Credentials>
<Username>User</Username>
<Password>********</Password>
<Session />
</Credentials>
<Module>Downtime</Module>
<Location>Enterprise.Site1.Downtime1</Location>
<DependentFieldValues>
<DependentFieldValue name="Cause Location">Enterprise.Site1</DependentFieldValue>
<DependentFieldValue name="Classification">Classification1</DependentFieldValue>
</DependentFieldValues>
<LocationIdentifier>Location1</LocationIdentifier>
</GetRelationshipMatrixValuesRequest>
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: Context section
<Module>Downtime</Module>
<Location>Enterprise.Site1.Downtime1</Location>
<DependentFieldValues>
<DependentFieldValue name="Cause Location">Enterprise.Site1</DependentFieldValue>
<DependentFieldValue name="Classification">Classification1</DependentFieldValue>
</DependentFieldValues>
<LocationIdentifier>Location1</LocationIdentifier>
|
Parameter |
Description |
|---|---|
|
Module |
Module maps to one of the standard AVEVA Production Management modules. Relationship matrices exist only in the Downtime and Energy modules. |
|
Location |
You provide the Location field. The Location field specifies the exact reporting point that you want to query. Do not use the parent folder. |
|
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. |
Request parameters: DependentFieldValues section
Contains the set of dependent field values.
<DependentFieldValues>
<DependentFieldValue name="Cause Location">Enterprise.Site1</DependentFieldValue>
<DependentFieldValue name="Classification">Classification1</DependentFieldValue>
</DependentFieldValues>
|
Parameter |
Description |
|---|---|
|
DependentFieldValue |
Name and value for each dependent field value; for example, CauseLocation. |