Batch Update Program Risk Mitigations
put
/api/restapi/programRiskMitigation/batch
Send a request to this endpoint to update one or more program risk mitigations.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : List<ApiEntityProgramRiskMitigationInput>
Type:
array
Title:
Show Source
List<ApiEntityProgramRiskMitigationInput>
-
Array of:
object ApiEntityProgramRiskMitigationInput
Title:
ApiEntityProgramRiskMitigationInput
This entity represents a ProgramRiskMitigation object, a unique ProgramRiskMitigation object can be identified by the following combinations of the fields.- programRiskMitigationId
- programRiskMitigationCode,programRiskId
- programRiskMitigationCode,riskCode,programId
- programRiskMitigationCode,riskCode,programCode,workspaceCode
Nested Schema : ApiEntityProgramRiskMitigationInput
Type:
object
Title:
ApiEntityProgramRiskMitigationInput
This entity represents a ProgramRiskMitigation object, a unique ProgramRiskMitigation object can be identified by the following combinations of the fields.
Show Source
- programRiskMitigationId
- programRiskMitigationCode,programRiskId
- programRiskMitigationCode,riskCode,programId
- programRiskMitigationCode,riskCode,programCode,workspaceCode
-
description: string
Minimum Length:
0
Maximum Length:4000
The detailed summary of the risk mitigation. -
finishDate: string
(date-time)
The latest finish date of all risk response action items. If the activity ID is null, then this field is READ ONLY.
-
link: string(url)Read Only:true
Deprecated. As of 23.10.The self-link to the object. This field is populated only in the responses generated by the batch create APIs. -
mitigationStatus: string
Allowed Values:
[ "PROPOSED", "SANCTIONED", "NOT_STARTED", "REJECTED", "IN_PROGRESS", "COMPLETED" ]
The status of the risk response action item.
Proposed: The response action has been proposed.
Sanctioned: The response action has been sanctioned.
Not Started: The response action has not started.
In Progress: The response action has started but has not been completed.
Completed: The response action has been completed.
Rejected: The response action has been rejected. -
ownerId: integer
(int64)
The name of the resource responsible for the risk response action item.
-
plannedFinishDate: string
(date-time)
The latest scheduled finish date of all the risk response action items. If the activity ID is null, then this field is READ ONLY.
-
plannedStartDate: string
(date-time)
The earliest scheduled start date of all risk response action items. If the activity ID is null, then this field is READ ONLY.
-
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.
-
programRiskId(required): integer
(int64)
The system-generated identifier of the project risk.
-
programRiskMitigationCode: string
Minimum Length:
0
Maximum Length:60
The unique identifier for the risk response action item. -
programRiskMitigationFinancial:
programRiskMitigationFinancial
The financial fields associated with a program risk mitigation.
-
programRiskMitigationId: integer
(int64)
The system-generated identifier of a risk mitigation.
-
programRiskMitigationName(required): string
Minimum Length:
0
Maximum Length:255
The name of the risk response action item. -
riskCode: string
Minimum Length:
1
Maximum Length:60
The unique identifier for the risk. -
startDate: string
(date-time)
The earliest start date of all risk response action items. If the activity ID is null, then this field is READ ONLY.
-
updateDate: string(date-time)Read Only:true
Deprecated. As of 23.10.Date when the record was last updated. -
workspaceCode: string
Minimum Length:
0
Maximum Length:60
The user-specified identifier of a workspace.
Nested Schema : programRiskMitigationFinancial
The financial fields associated with a program risk mitigation.
Match All
Show Source
-
object
ApiEntityProgramRiskMitigationFinancialInput
Title:
ApiEntityProgramRiskMitigationFinancialInput
Nested Schema : ApiEntityProgramRiskMitigationFinancialInput
Type:
object
Title:
Show Source
ApiEntityProgramRiskMitigationFinancialInput
-
actualCost: number
(double)
The response action Actual Cost.
-
atCompletionTotalCost: number(double)Read Only:true
Deprecated. As of 23.11.The response action At Completion Cost. -
link: string(url)Read Only:true
Deprecated. As of 23.10.The self-link to the object. This field is populated only in the responses generated by the batch create APIs. -
postResponseActualCost: number(double)Read Only:true
Deprecated. As of 23.11.The response action Post-Response Actual Cost. -
postResponseAtCompletionTotalCost: number(double)Read Only:true
Deprecated. As of 23.11.The response action Post-Response At Completion Cost. -
postResponseRemainingTotalCost: number(double)Read Only:true
Deprecated. As of 23.11.The response action Post-Response Remaining Cost. -
preResponseActualCost: number(double)Read Only:true
Deprecated. As of 23.11.The response action Pre-Response Actual Cost. -
preResponseAtCompletionCost: number(double)Read Only:true
Deprecated. As of 23.11.The response action Pre-Response At Completion Cost. -
preResponseRemainingTotalCost: number(double)Read Only:true
Deprecated. As of 23.11.The response action Pre-Response Remaining Cost. -
programRiskMitigationId: integer
(int64)
The system-generated identifier of a risk mitigation.
-
remainingTotalCost: number
(double)
The response action Remaining Cost.
-
updateDate: string(date-time)Read Only:true
Deprecated. As of 23.10.Date when the record was last updated.
Examples
Back to Top
Response
200 Response
A collection of object IDs mapped to a canonical link of the object. For example - {"links":{"1":"https://[host]:[port]/api/restapi/[object]/1","2":"https://[host]:[port]/api/restapi/[object]/2"}}
400 Response
Invalid input.