Update a Project Risk

put

/api/restapi/projectRisk

Send a request to this endpoint to update a project risk.

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/json ()
Root Schema : ApiEntityProjectRiskInput
Type: object
Title: ApiEntityProjectRiskInput
This entity represents a ProjectRisk object, a unique ProjectRisk object can be identified by the following combinations of the fields.
  • projectRiskId
  • riskCode,projectId
  • riskCode,projectCode,workspaceCode
Show Source
Nested Schema : cbsCodes
Type: array
List of cbs codes in hierarchy for the CBS which needs to be associated with the item. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.
Show Source
Nested Schema : codeValuesRisk
Type: array
The list of code values for a project risk. This entity can only be used to assign codeValues or create codeValues on the fly.
Show Source
  • ApiEntityCodeValueRiskInput
    Title: ApiEntityCodeValueRiskInput
    This entity represents a CodeValueRisk object, a unique CodeValueRisk object can be identified by the following combinations of the fields.
    • codeValueRiskId
    • codeValueId
    • codeTypeId,codeValueCode
    • codeTypeCode,codeValueCode
    • codeTypeCode,parentId,codeValueCode
    • codeValueCode,codeTypeId,parentId
    • codeTypeCode,codeValueCode,projectCode
    • codeTypeCode,codeValueCode,projectId
    • codeTypeCode,codeValueCode,parentId,projectCode
    • codeTypeCode,codeValueCode,parentId,projectId
Nested Schema : configuredFields
Type: array
The list of configured fields for a project risk.
Show Source
  • ApiEntityProjectRiskConfiguredFieldValueInput
    Title: ApiEntityProjectRiskConfiguredFieldValueInput
    This entity represents a ProjectRiskConfiguredFieldValue object, a unique ProjectRiskConfiguredFieldValue object can be identified by the following combinations of the fields.
    • projectRiskConfiguredFieldValueId
    • columnDefinitionId
    • columnName
    • columnLabel
Nested Schema : impacts
Type: array
The impact of the risk.
Show Source
Nested Schema : projectRiskFinancial
The financial fields associated with a project risk.
Match All
Show Source
Nested Schema : riskQuantifiedCostImpact
The impact this risk will have on cost data.
Match All
Show Source
Nested Schema : riskQuantifiedOtherImpacts
Type: array
The impact this risk will have on other data.
Show Source
Nested Schema : ApiEntityCodeValueRiskInput
Type: object
Title: ApiEntityCodeValueRiskInput
This entity represents a CodeValueRisk object, a unique CodeValueRisk object can be identified by the following combinations of the fields.
  • codeValueRiskId
  • codeValueId
  • codeTypeId,codeValueCode
  • codeTypeCode,codeValueCode
  • codeTypeCode,parentId,codeValueCode
  • codeValueCode,codeTypeId,parentId
  • codeTypeCode,codeValueCode,projectCode
  • codeTypeCode,codeValueCode,projectId
  • codeTypeCode,codeValueCode,parentId,projectCode
  • codeTypeCode,codeValueCode,parentId,projectId
Show Source
Nested Schema : ApiEntityProjectRiskConfiguredFieldValueInput
Type: object
Title: ApiEntityProjectRiskConfiguredFieldValueInput
This entity represents a ProjectRiskConfiguredFieldValue object, a unique ProjectRiskConfiguredFieldValue object can be identified by the following combinations of the fields.
  • projectRiskConfiguredFieldValueId
  • columnDefinitionId
  • columnName
  • columnLabel
Show Source
  • Allowed Values: [ "DELETE" ]
    Provide value for this field during object update to delete the assigned configured field value.
  • Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.
  • Minimum Length: 1
    Maximum Length: 100
    The user-specified UDF column label.
  • Minimum Length: 1
    Maximum Length: 100
    The user-specified UDF column name.
  • Read Only: true
    Deprecated. As of 23.10.
    This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.
  • Read Only: true
    Deprecated. As of 23.10.
    This holds values for Cost type configured fields in the workspace1 currency conversion.
  • Read Only: true
    Deprecated. As of 23.10.
    This holds values for Cost type configured fields in the workspace2 currency conversion.
  • Read Only: true
    Deprecated. As of 23.10.
    This holds values for Cost type configured fields in the workspace3 currency conversion.
  • This holds values for Date type configured fields.
  • Read Only: true
    Maximum Length: 4000
    Deprecated. As of 23.10.
    Provides the error message for why the formula calculation resulted in an error.
  • Read Only: true
    Deprecated. As of 23.10.
    Determines if formula calculation hit an error calculating a value for this field.
  • This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.
  • The unique identifier for the Risk Configured Field.
  • The system-generated identifier of a Risk.
  • Maximum Length: 4000
    This holds values for Boolean, List and Text type configured fields.
  • Read Only: true
    Deprecated. As of 23.10.
    Date when the record was last updated.
Nested Schema : ApiEntityRiskImpactInput
Type: object
Title: ApiEntityRiskImpactInput
Show Source
Nested Schema : ApiEntityProjectRiskFinancialInput
Type: object
Title: ApiEntityProjectRiskFinancialInput
Show Source
Nested Schema : ApiEntityRiskQuantifiedCostImpactInput
Type: object
Title: ApiEntityRiskQuantifiedCostImpactInput
Show Source
Nested Schema : ApiEntityRiskQuantifiedOtherImpactInput
Type: object
Title: ApiEntityRiskQuantifiedOtherImpactInput
Show Source
Examples

Back to Top

Response

204 Response

Successful operation with no content.

400 Response

Invalid input.
Back to Top