GetRelationshipMatrixValues response message
- Last UpdatedFeb 18, 2025
- 1 minute read
This is an example of the full structure of a GetRelationshipMatrixValues response message.
<GetRelationshipMatrixValuesResponse>
<Context>
<Module>Downtime</Module>
<Location>Enterprise.Site1.Downtime1</Location>
<DependentFieldValues>
<DependentFieldValue name="Cause Location">Enterprise.Site1</DependentFieldValue>
</DependentFieldValues>
</Context>
<RelationshipMatrixValues>
<RelationshipMatrixValue>
<MatrixValues>
<MatrixValue id="19810" name="Classification">Classification3</MatrixValue>
<MatrixValue id="10205" name="Cause">CauseCode3</MatrixValue>
<MatrixValue id="E14645" name="Effect">Effect3</MatrixValue>
</MatrixValues>
</RelationshipMatrixValue>
<RelationshipMatrixValue>
<MatrixValues>
<MatrixValue id="26694" name="Classification">Classification4</MatrixValue>
<MatrixValue id="10205" name="Cause">CauseCode3</MatrixValue>
<MatrixValue id="E14645" name="Effect">Effect3</MatrixValue>
</MatrixValues>
</RelationshipMatrixValue>
</RelationshipMatrixValues>
</GetRelationshipMatrixValuesResponse>
Response parameters: Context section
Reports the context and location of the original request.
<Context>
<Module>Downtime</Module>
<Location>Enterprise.Site1.Downtime1</Location>
<DependentFieldValues>
<DependentFieldValue name="Cause Location">Enterprise.Site1</DependentFieldValue>
</DependentFieldValues>
</Context>
|
Parameter |
Description |
|---|---|
|
Module |
Returns the module specified in the request. Relationship matrices exist only in the Downtime and Energy modules. |
|
Location |
(Required) Maps to a folder location when navigating "by location." |
|
DependentFieldValues |
Contains the set of dependent field values. |
|
DependentFieldValue |
Name and value for each dependent field value; for example, CauseLocation. |
Response parameters: RelationshipMatrixValues section
Contains the subsets of RelationshipMatrixValues.
<RelationshipMatrixValues>
<RelationshipMatrixValue>
<MatrixValues>
<MatrixValue id="19810" name="Classification">ElectricalFault</MatrixValue>
<MatrixValue id="10205" name="Cause">BlownFuse</MatrixValue>
<MatrixValue id="14645" name="Effect">PowerStoppage</MatrixValue>
</MatrixValues>
</RelationshipMatrixValue>
|
Parameter |
Description |
|---|---|
|
RelationshipMatrixValue |
Contains the subsets of MatrixValues. |
|
MatrixValues |
Contains the set of MatrixValues. |
|
MatrixValue |
Returns the names and values for the three lower fields of the relationship matrix, if available: Cause, Effect, Classification. |