View all Risk Score Types by Workspace
get
/api/restapi/riskScoreType/workspace/{workspaceId}
This endpoint returns risk score types that meet the following requirements:
- The object is associated with a workspace with an ID value that matches the value of the {workspaceId} path parameter.
Request
Path Parameters
-
workspaceId(required): integer(int64)
The system-generated identifier of a workspace.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : List<ApiEntityRiskScoreType>
Type:
array
Title:
Show Source
List<ApiEntityRiskScoreType>
-
Array of:
object ApiEntityRiskScoreType
Title:
ApiEntityRiskScoreType
Nested Schema : ApiEntityRiskScoreType
Type:
object
Title:
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:
60
The 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:
1
Maximum Length:60
The 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:
0
Maximum Length:255
The 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:
0
Maximum Length:60
The 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:
array
An array of the risk threshold values for a selected risk threshold.
Show Source
-
Array of:
object ApiEntityRiskScoreThreshold
Title:
ApiEntityRiskScoreThreshold
Nested Schema : ApiEntityRiskScoreThreshold
Type:
object
Title:
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:
6
Maximum Length:6
The color that represents the urgency of the risk. -
level: integer
(int32)
Minimum Value:
0
Maximum Value:10
The 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:
0
Maximum Length:60
The unique identifier for the risk scoring threshold. -
riskScoreThresholdId: integer
(int64)
The unique ID of the risk score threshold.
-
riskScoreThresholdName: string
Minimum Length:
0
Maximum Length:255
The name of the risk threshold. -
riskScoreTypeId: integer
(int64)
The category to which the risk score belongs.
-
riskScoreTypeName: string
Minimum Length:
0
Maximum Length:255
The name of the risk score type. -
stringValue: string
Minimum Length:
0
Maximum Length:255
The 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.
204 Response
Successful operation with no content.
404 Response
The requested risk score type does not exist, or you do not have access to it.