View all Program Risk Mitigations by Program Risk ID
get
/api/restapi/programRiskMitigation/programRisk/{programRiskId}
This endpoint returns program risk mitigations that meet the following requirements:
- The object is associated with a program risk with an ID value that matches the value of the {programRiskId} path parameter.
Request
Path Parameters
-
programRiskId(required): integer(int64)
The system-generated identifier of a program risk.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : List<ApiEntityProgramRiskMitigation>
Type:
array
Title:
Show Source
List<ApiEntityProgramRiskMitigation>
-
Array of:
object ApiEntityProgramRiskMitigation
Title:
ApiEntityProgramRiskMitigation
Nested Schema : ApiEntityProgramRiskMitigation
Type:
object
Title:
Show Source
ApiEntityProgramRiskMitigation
-
activityAssigned: boolean
Indicates whether an activity is assigned to the response action.
-
description: string
Minimum Length:
0
Maximum Length:4000
The detailed summary of the risk mitigation. -
finishAfterExposure: string
Allowed Values:
[ "TRUE", "FALSE", "MISSING_DATES" ]
Indicates whether the response action finishes after the start of exposure to the risk. -
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)
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: 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: 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.
-
timing: string
Allowed Values:
[ "STARTING_LATE", "FINISHING_LATE", "MISSING_DATES" ]
Indicates whether the response action start or finish is before today's date. -
uniqueCode: string
Maximum Length:
128
A unique identifier for each Risk Mitigation per project that consists of the parent Risk Code followed by the Risk Mitigation Code. -
updateDate: string
(date-time)
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
ApiEntityProgramRiskMitigationFinancial
Title:
ApiEntityProgramRiskMitigationFinancial
Nested Schema : ApiEntityProgramRiskMitigationFinancial
Type:
object
Title:
Show Source
ApiEntityProgramRiskMitigationFinancial
-
actualCost: number
(double)
The response action Actual Cost.
-
atCompletionTotalCost: number
(double)
The response action At Completion Cost.
-
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
postResponseActualCost: number
(double)
The response action Post-Response Actual Cost.
-
postResponseAtCompletionTotalCost: number
(double)
The response action Post-Response At Completion Cost.
-
postResponseRemainingTotalCost: number
(double)
The response action Post-Response Remaining Cost.
-
preResponseActualCost: number
(double)
The response action Pre-Response Actual Cost.
-
preResponseAtCompletionCost: number
(double)
The response action Pre-Response At Completion Cost.
-
preResponseRemainingTotalCost: number
(double)
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)
Date when the record was last updated.
204 Response
Successful operation with no content.
400 Response
Invalid input.