Batch Create Project Risk Mitigations
post
/api/restapi/riskMitigation/batch
Send a request to this endpoint to create one or more project risk mitigations.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : List<ApiEntityRiskMitigationInput>
Type:
array
Title:
Show Source
List<ApiEntityRiskMitigationInput>
-
Array of:
object ApiEntityRiskMitigationInput
Title:
ApiEntityRiskMitigationInput
This entity represents a RiskMitigation object, a unique RiskMitigation object can be identified by the following combinations of the fields.- riskMitigationId
- riskMitigationCode,projectRiskId
- riskMitigationCode,riskCode,projectId
- riskMitigationCode,riskCode,projectCode,workspaceCode
Nested Schema : ApiEntityRiskMitigationInput
Type:
object
Title:
ApiEntityRiskMitigationInput
This entity represents a RiskMitigation object, a unique RiskMitigation object can be identified by the following combinations of the fields.
Show Source
- riskMitigationId
- riskMitigationCode,projectRiskId
- riskMitigationCode,riskCode,projectId
- riskMitigationCode,riskCode,projectCode,workspaceCode
-
activityCode: string
Maximum Length:
60
The user-specified identifier of the activity. -
activityId: integer
(int64)
The system-generated identifier of the activity.
-
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.
-
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.
-
projectName: stringRead Only:true
Maximum Length:255
Deprecated. As of 23.11.The name of the project. -
projectRiskId(required): integer
(int64)
The system-generated identifier of the project risk.
-
riskCode: string
Minimum Length:
1
Maximum Length:60
The unique identifier for the risk. -
riskMitigationCode: string
Minimum Length:
0
Maximum Length:60
The unique identifier for the risk response action item. -
riskMitigationFinancial:
riskMitigationFinancial
The financial fields associated with a risk mitigation.
-
riskMitigationId: integer
(int64)
The system-generated identifier of a risk mitigation.
-
riskMitigationName(required): string
Minimum Length:
0
Maximum Length:255
The name of the risk response action item. -
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 : riskMitigationFinancial
The financial fields associated with a risk mitigation.
Match All
Show Source
-
object
ApiEntityRiskMitigationFinancialInput
Title:
ApiEntityRiskMitigationFinancialInput
Nested Schema : ApiEntityRiskMitigationFinancialInput
Type:
object
Title:
Show Source
ApiEntityRiskMitigationFinancialInput
-
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. -
remainingTotalCost: number
(double)
The response action Remaining Cost.
-
riskMitigationId: integer
(int64)
The system-generated identifier of a risk mitigation.
-
updateDate: string(date-time)Read Only:true
Deprecated. As of 23.10.Date when the record was last updated.
Examples
Back to Top
Response
Supported Media Types
- application/json
201 Response
The object was successfully created.
Root Schema : List<ApiEntityRiskMitigation>
Type:
array
Title:
Show Source
List<ApiEntityRiskMitigation>
-
Array of:
object ApiEntityRiskMitigation
Title:
ApiEntityRiskMitigation
Nested Schema : ApiEntityRiskMitigation
Type:
object
Title:
Show Source
ApiEntityRiskMitigation
-
activityAssigned: boolean
Indicates whether an activity is assigned to the response action.
-
activityCode: string
Maximum Length:
60
The user-specified identifier of the activity. -
activityId: integer
(int64)
The system-generated identifier of the activity.
-
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.
-
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.
-
projectName: string
Maximum Length:
255
The name of the project. -
projectRiskId: integer
(int64)
The system-generated identifier of the project risk.
-
riskCode: string
Minimum Length:
1
Maximum Length:60
The unique identifier for the risk. -
riskMitigationCode: string
Minimum Length:
0
Maximum Length:60
The unique identifier for the risk response action item. -
riskMitigationFinancial:
riskMitigationFinancial
The financial fields associated with a risk mitigation.
-
riskMitigationId: integer
(int64)
The system-generated identifier of a risk mitigation.
-
riskMitigationName: string
Minimum Length:
0
Maximum Length:255
The name of the risk response action item. -
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 : riskMitigationFinancial
The financial fields associated with a risk mitigation.
Match All
Show Source
-
object
ApiEntityRiskMitigationFinancial
Title:
ApiEntityRiskMitigationFinancial
Nested Schema : ApiEntityRiskMitigationFinancial
Type:
object
Title:
Show Source
ApiEntityRiskMitigationFinancial
-
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.
-
remainingTotalCost: number
(double)
The response action Remaining Cost.
-
riskMitigationId: integer
(int64)
The system-generated identifier of a risk mitigation.
-
updateDate: string
(date-time)
Date when the record was last updated.
400 Response
Invalid input.