Batch Update Project Risks

put

/api/restapi/projectRisk/batch

Send a request to this endpoint to update one or more project risks.

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/json ()
Root Schema : List<ApiEntityProjectRiskInput>
Type: array
Title: List<ApiEntityProjectRiskInput>
Show Source
  • ApiEntityProjectRiskInput
    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
Nested 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
The financial fields associated with a project risk.
Show Source
Nested Schema : riskQuantifiedCostImpact
The impact this risk will have on cost data.
Match All
The impact this risk will have on cost data.
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
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

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.
Back to Top