View a Risk Matrix
get
/api/restapi/riskMatrix/{riskMatrixId}
This endpoint returns risk matrixes that meet the following requirements:
- The object has an ID that matches the value of the {riskMatrixId} path parameter.
Request
Path Parameters
-
riskMatrixId(required): integer(int64)
The system-generated identifier of a risk matrix.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : ApiEntityRiskMatrix
Type:
objectTitle:
Show Source
ApiEntityRiskMatrix-
associationType: string
Allowed Values:
[ "OWNED", "INHERITED" ]The type of association in the relationship between the risk matrix and the workspace. Possible values are Owned and Inherited. -
impactLevels: integer
(int32)
The degree to which a risk matrix is impacted.
-
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
matrixDescription: string
Minimum Length:
0Maximum Length:4000The detailed summary of the risk scoring matrix. -
matrixName: string
Minimum Length:
1Maximum Length:60The name of the risk scoring matrix. -
probabilityLevels: integer
(int32)
A count of the number of levels (thresholds) for the probability score type associated with the matrix. This does not count the Negligible level.
-
programCode: string
Maximum Length:
60The unique identifier for a program set by the user who created the program. -
programId: integer
(int64)
The unique identifier for the program.
-
projectCode: string
Minimum Length:
1Maximum Length:60The unique identifier for a project set by the user who created the project. -
projectId: integer
(int64)
The unique identifier for the project.The project object can also be identified by its unique criteria.
-
pushDownType: string
Allowed Values:
[ "MANUAL", "AUTOMATIC" ]The push down type of the risk matrix. -
referencedRiskMatrixId: integer
(int64)
Unique identifier of a risk matrix.
-
riskMatrixId: integer
(int64)
The system-generated identifier of the risk matrix.
-
riskScoreMatrixMethod: string
Allowed Values:
[ "HIGHEST", "AVERAGE_IMPACTS", "AVERAGE_INDIVIDUAL_SCORES" ]The type of calculation used to obtain an overall impact value. The valid values are Highest Impact and Average Impact. -
scores: array
scores
List of risk scores associated with the risk matrix.
-
scoreTypes: array
scoreTypes
List of risk types associated with the risk matrix.
-
tolerances: array
tolerances
List of risk tolerances associated with the risk matrix.
-
updateDate: string
(date-time)
Date when the record was last updated.
-
workspaceCode: string
Minimum Length:
0Maximum Length:60The user-specified identifier of a workspace. -
workspaceId: integer
(int64)
The workspace that contains the risk matrix.
Nested Schema : scores
Type:
arrayList of risk scores associated with the risk matrix.
Show Source
-
Array of:
object ApiEntityRiskMatrixScore
Title:
ApiEntityRiskMatrixScore
Nested Schema : scoreTypes
Type:
arrayList of risk types associated with the risk matrix.
Show Source
-
Array of:
object ApiEntityRiskMatrixScoreType
Title:
ApiEntityRiskMatrixScoreType
Nested Schema : tolerances
Type:
arrayList of risk tolerances associated with the risk matrix.
Show Source
-
Array of:
object ApiEntityRiskMatrixTolerance
Title:
ApiEntityRiskMatrixTolerance
Nested Schema : ApiEntityRiskMatrixScore
Type:
objectTitle:
Show Source
ApiEntityRiskMatrixScore-
action: string
Allowed Values:
[ "DELETE" ]Provide a value for this field during object update to delete the particular nested entry in the list of scores. A valid riskMatrixScoreId or probabilityThresholdLevel value must be provided to perform deletion. -
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
matrixName: string
Maximum Length:
60The name of the risk scoring matrix. -
probabilityThresholdLevel: integer
(int32)
Minimum Value:
1Maximum Value:9The level at which threshold probability is measured. -
riskMatrixId: integer
(int64)
The unique identifier of a risk scoring matrix.
-
riskMatrixScoreId: integer
(int64)
The unique identifier of a risk matrix score.
-
severityEight: integer
(int32)
Minimum Value:
-1000000000Maximum Value:1000000000The severity level of schedule and cost impacts in your risk scoring matrix. -
severityEightLabel: string
Minimum Length:
0Maximum Length:40The severity level of schedule and cost impacts in your risk scoring matrix. -
severityFive: integer
(int32)
Minimum Value:
-1000000000Maximum Value:1000000000The severity level of schedule and cost impacts in your risk scoring matrix. -
severityFiveLabel: string
Minimum Length:
0Maximum Length:40The severity level of schedule and cost impacts in your risk scoring matrix. -
severityFour: integer
(int32)
Minimum Value:
-1000000000Maximum Value:1000000000The severity level of schedule and cost impacts in your risk scoring matrix. -
severityFourLabel: string
Minimum Length:
0Maximum Length:40The severity level of schedule and cost impacts in your risk scoring matrix. -
severityNine: integer
(int32)
Minimum Value:
-1000000000Maximum Value:1000000000The severity level of schedule and cost impacts in your risk scoring matrix. -
severityNineLabel: string
Minimum Length:
0Maximum Length:40The severity level of schedule and cost impacts in your risk scoring matrix. -
severityOne: integer
(int32)
Minimum Value:
-1000000000Maximum Value:1000000000The severity level of schedule and cost impacts in your risk scoring matrix. -
severityOneLabel: string
Minimum Length:
0Maximum Length:40The severity level of schedule and cost impacts in your risk scoring matrix. -
severitySeven: integer
(int32)
Minimum Value:
-1000000000Maximum Value:1000000000The severity level of schedule and cost impacts in your risk scoring matrix. -
severitySevenLabel: string
Minimum Length:
0Maximum Length:40The severity level of schedule and cost impacts in your risk scoring matrix. -
severitySix: integer
(int32)
Minimum Value:
-1000000000Maximum Value:1000000000The severity level of schedule and cost impacts in your risk scoring matrix. -
severitySixLabel: string
Minimum Length:
0Maximum Length:40The severity level of schedule and cost impacts in your risk scoring matrix. -
severityThree: integer
(int32)
Minimum Value:
-1000000000Maximum Value:1000000000The severity level of schedule and cost impacts in your risk scoring matrix. -
severityThreeLabel: string
Minimum Length:
0Maximum Length:40The severity level of schedule and cost impacts in your risk scoring matrix. -
severityTwo: integer
(int32)
Minimum Value:
-1000000000Maximum Value:1000000000The severity level of schedule and cost impacts in your risk scoring matrix. -
severityTwoLabel: string
Minimum Length:
0Maximum Length:40The severity level of schedule and cost impacts in your risk scoring matrix. -
updateDate: string
(date-time)
Date when the record was last updated.
Nested Schema : ApiEntityRiskMatrixScoreType
Type:
objectTitle:
Show Source
ApiEntityRiskMatrixScoreType-
action: string
Allowed Values:
[ "DELETE" ]Provide a value for this field during object update to delete the particular nested entry in the list of scoreTypes. A valid riskMatrixScoreTypeId, riskScoreTypeId, or riskScoreTypeName value must be provided to perform deletion. -
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
matrixName: string
Minimum Length:
1Maximum Length:60The name of the risk scoring matrix. -
riskMatrixId: integer
(int64)
The unique identifier for the risk scoring matrix.
-
riskMatrixScoreTypeId: integer
(int64)
The unique identifier of a risk matrix score type.
-
riskScoreType:
riskScoreType
A risk score type.
-
riskScoreTypeId: integer
(int64)
The unique identifier for the risk matrix score type.
-
riskScoreTypeName: string
Minimum Length:
0Maximum Length:255The name of the risk score type. -
updateDate: string
(date-time)
Date when the record was last updated.
Nested Schema : riskScoreType
A risk score type.
Match All
Show Source
-
object
ApiEntityRiskScoreType
Title:
ApiEntityRiskScoreType
Nested Schema : ApiEntityRiskScoreType
Type:
objectTitle:
Show Source
ApiEntityRiskScoreType-
associationType: string
Allowed Values:
[ "OWNED", "INHERITED" ]The type of association in the relationship between the risk score type and the workspace. Possible values are Owned and Inherited. -
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
programCode: string
Maximum Length:
60The unique identifier for a program set by the user who created the program. -
programId: integer
(int64)
The unique identifier for the program.
-
projectCode: string
Minimum Length:
1Maximum Length:60The unique identifier for a project set by the user who created the project. -
projectId: integer
(int64)
The unique identifier for the project.The project object can also be identified by its unique criteria.
-
pushDownType: string
Allowed Values:
[ "MANUAL", "AUTOMATIC" ]The push down type of the risk score. -
referencedScoreTypeId: integer
(int64)
The unique identifier of a copied score type.
-
riskScoreThresholds: array
riskScoreThresholds
An array of the risk threshold values for a selected risk threshold.
-
riskScoreTypeId: integer
(int64)
The unique identifier of a score type.
-
riskScoreTypeName: string
Minimum Length:
0Maximum Length:255The name of the risk score type. -
scoreType: string
Allowed Values:
[ "PROBABILITY", "SCHEDULE", "RELATIVE_SCHEDULE", "COST", "RELATIVE_COST", "USER" ]The type of risk score. -
updateDate: string
(date-time)
Date when the record was last updated.
-
workspaceCode: string
Minimum Length:
0Maximum Length:60The code of a workspace associated to a risk score. -
workspaceId: integer
(int64)
The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.
Nested Schema : riskScoreThresholds
Type:
arrayAn array of the risk threshold values for a selected risk threshold.
Show Source
-
Array of:
object ApiEntityRiskScoreThreshold
Title:
ApiEntityRiskScoreThreshold
Nested Schema : ApiEntityRiskScoreThreshold
Type:
objectTitle:
Show Source
ApiEntityRiskScoreThreshold-
action: string
Allowed Values:
[ "DELETE" ]Provide a value for this field during object update to delete the particular nested entry in the list of risk score thresholds. A valid riskScoreThresholdId, riskScoreThresholdCode, or level value must be provided to perform deletion. -
color: string
Minimum Length:
6Maximum Length:6The color that represents the urgency of the risk. -
level: integer
(int32)
Minimum Value:
0Maximum Value:10The level of the risk threshold. -
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
lower: number
(double)
The lower limit of the risk score threshold range.
-
riskScoreThresholdCode: string
Minimum Length:
0Maximum Length:60The unique identifier for the risk scoring threshold. -
riskScoreThresholdId: integer
(int64)
The unique ID of the risk score threshold.
-
riskScoreThresholdName: string
Minimum Length:
0Maximum Length:255The name of the risk threshold. -
riskScoreTypeId: integer
(int64)
The category to which the risk score belongs.
-
riskScoreTypeName: string
Minimum Length:
0Maximum Length:255The name of the risk score type. -
stringValue: string
Minimum Length:
0Maximum Length:255The value of the string. -
updateDate: string
(date-time)
Date when the record was last updated.
-
upper: number
(double)
The upper limit of the risk score threshold range.
Nested Schema : ApiEntityRiskMatrixTolerance
Type:
objectTitle:
Show Source
ApiEntityRiskMatrixTolerance-
action: string
Allowed Values:
[ "DELETE" ]Provide value for this field during object update to delete the particular nested entry in the list of tolerances. A valid riskMatrixToleranceId or value must be provided to perform deletion. -
color: string
Minimum Length:
1Maximum Length:6Color that represents the urgency of the risk. -
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
riskMatrixId: integer
(int64)
The unique identifier for the risk matrix.
-
riskMatrixName: string
Minimum Length:
1Maximum Length:60The name of the risk scoring matrix. -
riskMatrixToleranceId: integer
(int64)
The unique identifier of a matrix tolerance.
-
updateDate: string
(date-time)
Date when the record was last updated.
-
value: number
(double)
A risk matrix tolerance value.
404 Response
The requested risk matrix does not exist, or you do not have access to it.