View Workspace Risk Matrix Template by Name
get
/primeapi/restapi/riskMatrix/resolveByName/{name}
View risk matrixes that belong to workspaces that meet the following requirements:
- The object has a name that matches the value of the {name} path parameter.
Request
Path Parameters
-
name: string
The name of a risk matrix.
Response
Supported Media Types
- application/json
200 Response
successful operation
Root Schema : ApiEntityRiskMatrix
Type:
Show Source
object
-
impactLevels(optional):
integer(int32)
The degree to which a risk matrix is impacted.
-
link(optional):
string(url)
Read Only:
true
-
matrixDescription(optional):
string
The detailed summary of the risk scoring matrix.
-
matrixName(optional):
string
The name of the risk scoring matrix.
-
probabilityLevels(optional):
integer(int32)
A count of the number of levels (thresholds) for the probability scoretype associated with the matrix. This does not count the Negligible level.
-
projectId(optional):
integer(int64)
The unique identifier of a project.
-
pushDownType(optional):
string
Allowed Values:
[ "MANUAL", "AUTOMATIC" ]
The push down type of the risk matrix. -
referencedRiskMatrixId(optional):
integer(int64)
Unique identifier of a risk matrix.
-
riskMatrixId(optional):
integer(int64)
The ID of the risk matrix.
-
riskScoreMatrixMethod(optional):
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(optional):
array scores
Unique Items Required:
true
Risk scores. -
scoreTypes(optional):
array scoreTypes
Unique Items Required:
true
Score types. -
tolerances(optional):
array tolerances
Unique Items Required:
true
Risk tolerances. -
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
workspace(optional):
object ApiEntityWorkspace
-
workspaceId(optional):
integer(int64)
The workspace that contains the risk matrix.
Nested Schema : ApiEntityWorkspace
Type:
Show Source
object
-
description(optional):
string
Summary of the workspace.
-
image(optional):
object ApiEntityWorkspaceImage
-
isProduction(optional):
boolean
Read Only:
true
Indicates a workspace that is in production.
All workspaces created under the Production workspace are automatically designated as production.
This cannot be changed. -
isSysGenerated(optional):
boolean
Read Only:
true
Indicates a workspace that was created by the system.
System generated workspaces cannot be deleted. -
link(optional):
string(url)
Read Only:
true
-
parentWorkspace(optional):
integer(int64)
The unique identifier of the workspace hierarchically above another workspace.
-
securityGuid(optional):
string
The Globally Unique Identifier of the workspace.
-
sequenceNumber(optional):
integer(int32)
Determines the order of appearance of workspaces in a list.
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
workspaceAutonumSettings(optional):
array workspaceAutonumSettings
Unique Items Required:
true
An object containing workspace autonumber settings. -
workspaceCode(optional):
string
Workspace Code.
-
workspaceId(optional):
integer(int64)
The unique identifier of a workspace.
-
workspaceName(optional):
string
Name of a workspace.
-
workspaceSettings(optional):
array workspaceSettings
Unique Items Required:
true
An object containing workspace settings.
Nested Schema : ApiEntityRiskMatrixScore
Type:
Show Source
object
-
link(optional):
string(url)
Read Only:
true
-
matrixName(optional):
string
-
probabilityThresholdLevel(optional):
integer(int32)
The level at which threshold probability is measured.
-
riskMatrix(optional):
object ApiEntityRiskMatrix
-
riskMatrixId(optional):
integer(int64)
The unique identifier of a risk scoring matrix.
-
riskMatrixScoreId(optional):
integer(int64)
The unique identifier of a risk matrix score.
-
severityEight(optional):
integer(int32)
The severity level of schedule and cost impacts in your risk scoring matrix.
-
severityEightLabel(optional):
string
The severity level of schedule and cost impacts in your risk scoring matrix.
-
severityFive(optional):
integer(int32)
The severity level of schedule and cost impacts in your risk scoring matrix.
-
severityFiveLabel(optional):
string
The severity level of schedule and cost impacts in your risk scoring matrix.
-
severityFour(optional):
integer(int32)
The severity level of schedule and cost impacts in your risk scoring matrix.
-
severityFourLabel(optional):
string
The severity level of schedule and cost impacts in your risk scoring matrix.
-
severityNine(optional):
integer(int32)
The severity level of schedule and cost impacts in your risk scoring matrix.
-
severityNineLabel(optional):
string
The severity level of schedule and cost impacts in your risk scoring matrix.
-
severityOne(optional):
integer(int32)
The severity level of schedule and cost impacts in your risk scoring matrix.
-
severityOneLabel(optional):
string
The severity level of schedule and cost impacts in your risk scoring matrix.
-
severitySeven(optional):
integer(int32)
The severity level of schedule and cost impacts in your risk scoring matrix.
-
severitySevenLabel(optional):
string
The severity level of schedule and cost impacts in your risk scoring matrix.
-
severitySix(optional):
integer(int32)
The severity level of schedule and cost impacts in your risk scoring matrix.
-
severitySixLabel(optional):
string
The severity level of schedule and cost impacts in your risk scoring matrix.
-
severityThree(optional):
integer(int32)
The severity level of schedule and cost impacts in your risk scoring matrix.
-
severityThreeLabel(optional):
string
The severity level of schedule and cost impacts in your risk scoring matrix.
-
severityTwo(optional):
integer(int32)
The severity level of schedule and cost impacts in your risk scoring matrix.
-
severityTwoLabel(optional):
string
The severity level of schedule and cost impacts in your risk scoring matrix.
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : ApiEntityRiskMatrixScoreType
Type:
Show Source
object
-
link(optional):
string(url)
Read Only:
true
-
matrixName(optional):
string
The name of the risk scoring matrix.
-
riskMatrix(optional):
object ApiEntityRiskMatrix
-
riskMatrixId(optional):
integer(int64)
The unique identifier for the risk scoring matrix.
-
riskMatrixScoreTypeId(optional):
integer(int64)
The unique identifier of a risk matrix score type.
-
riskScoreType(optional):
object ApiEntityRiskScoreType
-
riskScoreTypeId(optional):
integer(int64)
The unique identifier for the risk matrix score type.
-
riskScoreTypeName(optional):
string
The name of the risk score type.
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : ApiEntityRiskScoreType
Type:
Show Source
object
-
link(optional):
string(url)
Read Only:
true
-
projectId(optional):
integer(int64)
The unique identifier of a project.
-
pushDownType(optional):
string
Allowed Values:
[ "MANUAL", "AUTOMATIC" ]
The push down type of the risk score. -
referencedScoreTypeId(optional):
integer(int64)
The unique identifier of a copied score type.
-
riskScoreThresholds(optional):
array riskScoreThresholds
Unique Items Required:
true
Risk score thresholds. -
riskScoreTypeId(optional):
integer(int64)
The unique identifier of a score type.
-
riskScoreTypeName(optional):
string
The name of the risk score type.
-
scoreType(optional):
string
Allowed Values:
[ "PROBABILITY", "SCHEDULE", "RELATIVE_SCHEDULE", "COST", "RELATIVE_COST", "USER" ]
The type of risk score. -
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
workspace(optional):
object ApiEntityWorkspace
-
workspaceId(optional):
integer(int64)
The unique identifier of a workspace.
Nested Schema : riskScoreThresholds
Type:
array
Unique Items Required:
true
Risk score thresholds.
Show Source
Nested Schema : ApiEntityRiskScoreThreshold
Type:
Show Source
object
-
color(optional):
string
The color that represents the urgency of the risk.
-
level(optional):
integer(int32)
The level of the risk threshold.
-
link(optional):
string(url)
Read Only:
true
-
lower(optional):
number(double)
The lower limit of the risk score threshold range.
-
riskScoreThresholdCode(optional):
string
The unique identifier for the risk scoring threshold.
-
riskScoreThresholdId(optional):
integer(int64)
The unique ID of the risk score threshold.
-
riskScoreThresholdName(optional):
string
The name of the risk threshold.
-
riskScoreType(optional):
object ApiEntityRiskScoreType
-
riskScoreTypeId(optional):
integer(int64)
The category to which the risk score belongs.
-
riskScoreTypeName(optional):
string
The name of the risk score type.
-
stringValue(optional):
string
The value of the string.
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
upper(optional):
number(double)
The upper limit of the risk score threshold range.
Nested Schema : ApiEntityRiskMatrixTolerance
Type:
Show Source
object
-
color(optional):
string
Color that represents the urgency of the risk.
-
link(optional):
string(url)
Read Only:
true
-
riskMatrix(optional):
object ApiEntityRiskMatrix
-
riskMatrixId(optional):
integer(int64)
The unique identifier for the risk matrix.
-
riskMatrixName(optional):
string
The name of the risk scoring matrix.
-
riskMatrixToleranceId(optional):
integer(int64)
The unique identifier of a matrix tolerance.
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
value(optional):
number(double)
A risk matrix tolerance value.
Nested Schema : ApiEntityWorkspaceImage
Type:
Show Source
object
-
image(optional):
array image
An image object represented in binary format.
-
imageType:
string
Allowed Values:
[ "PNG", "JPEG", "GIF" ]
The file type of the image. Valid values are PNG, JPEG, and GIF. -
link(optional):
string(url)
Read Only:
true
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
workspaceId:
integer(int64)
The unique identifier of the workspace that contains this image.
-
workspaceImageId:
integer(int64)
The unique identifier of the image.
Nested Schema : workspaceAutonumSettings
Type:
array
Unique Items Required:
true
An object containing workspace autonumber settings.
Show Source
Nested Schema : workspaceSettings
Type:
array
Unique Items Required:
true
An object containing workspace settings.
Show Source
Nested Schema : ApiEntityWorkspaceAutonumSetting
Type:
Show Source
object
-
area(optional):
string
Allowed Values:
[ "IDEA", "ACTIVITY", "ACTIVITY_ASSIGNMENT", "SCOPE_ITEM", "SCOPE_ASSIGNMENT", "CHANGE_ITEM", "WORK_PACKAGE", "CHANGE_REQUEST", "CONTRACT", "COMMITMENT", "BUDGET_CHANGE", "BUDGET_TRANSFER", "CHANGE_ORDER", "POTENTIAL_CHANGE_ORDER", "PAYMENT_APPLICATION", "RISK", "ACTUALS", "WORK_MANAGER_TASK", "SUBMITTAL", "CHANGE_EVENT", "RFI", "CUSTOM_LOGS_ITEM" ]
Identifies the type of object used for auto numbering. -
autonumId(optional):
integer(int64)
The unique identifier of an auto numbering sequence.
-
link(optional):
string(url)
Read Only:
true
-
name(optional):
string
Name of the auto numbering sequence.
-
prefix(optional):
string
Initial characters for the workspace auto numbering sequence.
-
suffix(optional):
string
The first number in the workspace auto numbering sequence.
-
suffixIncrement(optional):
integer(int32)
Number by which the auto numbering suffix is incremented.
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
workspaceId(optional):
integer(int64)
The unique identifier of a workspace.
Nested Schema : ApiEntityWorkspaceSetting
Type:
Show Source
object
-
link(optional):
string(url)
Read Only:
true
-
settingName:
string
Name of a workspace setting.
-
settingValue:
string
Value of a workspace setting.
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
workspaceId:
integer(int64)
The unique identifier of a workspace setting.
-
workspaceSettingId:
integer(int64)
The unique identifier of a workspace setting.
404 Response
The requested risk matrix does not exist, or you do not have access to it.