GetRelationshipMatrix response message
- Last UpdatedAug 29, 2023
- 1 minute read
This is an example of the structure of a GetRelationshipMatrix response message.
<GetRelationshipMatrixResponse>
<Context>
<Module>Downtime</Module>
<Location>Enterprise.Site1.Downtime1</Location>
</Context>
<RelationshipMatrices>
<RelationshipMatrix>
<MatrixFields>
<MatrixFields>
<MatrixField>Classification</MatrixField>
</MatrixFields>
<MatrixFields>
<MatrixField>Cause</MatrixField>
</MatrixFields
<MatrixFields>
<MatrixField>Effect</MatrixField>
</MatrixFields>
</MatrixFields>
</RelationshipMatrix>
</RelationshipMatrices>
</GetRelationshipMatrixResponse>
Response parameters: Context section
Reports the context and location of the original request.
<Context>
<Module>Downtime</Module>
<Location>Enterprise.Site1.Downtime1</Location>
</Context>
|
Parameter |
Description |
|---|---|
|
Module |
Returns the module specified in the request. Relationship matrices exist only in the Downtime and Energy modules. |
|
Location |
Returns the navigation location. |
Response parameters: RelationshipMatrices section
Contains the set of relationship matrices.
<RelationshipMatrix>
<MatrixFields>
<MatrixFields>
<MatrixField>Classification</MatrixField>
</MatrixFields>
<MatrixFields>
<MatrixField>Cause</MatrixField>
</MatrixFields
<MatrixFields>
<MatrixField>Effect</MatrixField>
</MatrixFields>
</MatrixFields>
</RelationshipMatrix>
|
Parameter |
Description |
|---|---|
|
RelationshipMatrix |
The entire relationship matrix including matrix fields. |
|
MatrixFields |
Contains the set of matrix fields. |
|
MatrixField |
The name of the available matrix field; for example, Cause, Classification, Effect. |