Batch Update Risk Score Types
put
/api/restapi/riskScoreType/batch
Send a request to this endpoint to update one or more risk score types.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : List<ApiEntityRiskScoreTypeInput>
Type:
array
Title:
Show Source
List<ApiEntityRiskScoreTypeInput>
-
Array of:
object ApiEntityRiskScoreTypeInput
Title:
ApiEntityRiskScoreTypeInput
This entity represents a RiskScoreType object, a unique RiskScoreType object can be identified by the following combinations of the fields.- riskScoreTypeId
- riskScoreTypeName,projectId
- riskScoreTypeName,projectCode,workspaceCode
- riskScoreTypeName,workspaceId
- riskScoreTypeName,workspaceCode
Nested Schema : ApiEntityRiskScoreTypeInput
Type:
object
Title:
ApiEntityRiskScoreTypeInput
This entity represents a RiskScoreType object, a unique RiskScoreType object can be identified by the following combinations of the fields.
Show Source
- riskScoreTypeId
- riskScoreTypeName,projectId
- riskScoreTypeName,projectCode,workspaceCode
- riskScoreTypeName,workspaceId
- riskScoreTypeName,workspaceCode
-
associationType: stringRead Only:true
Allowed Values:[ "OWNED", "INHERITED" ]
Deprecated. As of 24.4.The type of association in the relationship between the risk score type and the workspace. Possible values are Owned and Inherited. -
link: string(url)Read Only:true
Deprecated. As of 24.4.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)Read Only:true
Deprecated. As of 24.4.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(required): string
Minimum Length:
0
Maximum Length:255
The name of the risk score type. -
scoreType(required): string
Allowed Values:
[ "PROBABILITY", "SCHEDULE", "RELATIVE_SCHEDULE", "COST", "RELATIVE_COST", "USER" ]
The type of risk score. -
updateDate: string(date-time)Read Only:true
Deprecated. As of 24.4.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(required): 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 ApiEntityRiskScoreThresholdInput
Title:
ApiEntityRiskScoreThresholdInput
Nested Schema : ApiEntityRiskScoreThresholdInput
Type:
object
Title:
Show Source
ApiEntityRiskScoreThresholdInput
-
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(required): string
Minimum Length:
6
Maximum Length:6
The color that represents the urgency of the risk. -
level(required): integer
(int32)
Minimum Value:
0
Maximum Value:10
The level of the risk threshold. -
link: string(url)Read Only:true
Deprecated. As of 24.4.The self-link to the object. This field is populated only in the responses generated by the batch create APIs. -
lower(required): number
(double)
The lower limit of the risk score threshold range.
-
riskScoreThresholdCode(required): 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(required): string
Minimum Length:
0
Maximum Length:255
The name of the risk threshold. -
riskScoreTypeId(required): integer
(int64)
The category to which the risk score belongs.
-
riskScoreTypeName: stringRead Only:true
Minimum Length:0
Maximum Length:255
Deprecated. As of 24.4.The name of the risk score type. -
stringValue: string
Minimum Length:
0
Maximum Length:255
The value of the string. -
updateDate: string(date-time)Read Only:true
Deprecated. As of 24.4.Date when the record was last updated. -
upper(required): number
(double)
The upper limit of the risk score threshold range.
Examples
Back to Top
Response
200 Response
A collection of object IDs mapped to a canonical link of the object with corresponding warning messages if any warnings were generated while processing the update request. For example - {"links":{"1":"https://[host]:[port]/api/restapi/[object]/1","2":"https://[host]:[port]/api/restapi/[object]/2"},"warnings":[{"primaryKeyName":"objectIdFieldName","uniqueFieldName":"object_code_01","uniqueFieldValue":"objectCodeFieldName","primaryKeyValue":1,"warningMessages":["warning_message_1","warning_message_2"]}]}
400 Response
Invalid input.