Jump to

• Request
• Response

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

• application/json

Request Body - application/json ()

Root Schema : List<ApiEntityProjectRiskInput>

Type: array

Title: List<ApiEntityProjectRiskInput>

Show Source

• Array of: object 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

{
    "title":"List<ApiEntityProjectRiskInput>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityProjectRiskInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

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

• actualScheduleImpact: number (double)
  The actual schedule impact due to the risk occurring.
• addressLine1: string
  Minimum Length: 0

  Maximum Length: 200

  The first line of the address of a location.
  This might be the building number and street address.
• addressLine2: string
  Minimum Length: 0

  Maximum Length: 200

  The second line of the address of a location.
  This might be a neighborhood or town.
• cause: string
  Minimum Length: 0

  Maximum Length: 4000

  A description of the cause of the risk.
• cbsCodes: array cbsCodes
  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.
• cbsSheetCodeId: integer (int64)
  The cost breakdown structure code assigned to the risk.
• city: string
  Minimum Length: 0

  Maximum Length: 200

  The city name for a location.
• codeValuesRisk: array codeValuesRisk
  The list of code values for a project risk. This entity can only be used to assign codeValues or create codeValues on the fly.
• configuredFields: array configuredFields
  The list of configured fields for a project risk.
• costCategoryId: integer (int64)
  The category name used to organize and define the cost.
• costImpactQuantified: boolean
  When selected, the quantified cost distribution is used to determine the cost impact for each iteration.
• country: string
  Minimum Length: 0

  Maximum Length: 3

  The country for a location.
• description: string
  Minimum Length: 0

  Maximum Length: 4000

  A detailed summary of the risk.
• effect: string
  Minimum Length: 0

  Maximum Length: 4000

  The resulting effect of the presence of the risk.
• excludeFromRiskRemovalAnalysis: boolean
  Default Value: false

  Determines whether the impact of removing the risk is calculated during risk removal risk analysis.
• hasPostResponseData: boolean
  Determines whether this risk has post-response values.
• identifiedById: integer (int64)
  The user who added the risk to the project.
• identifiedDate: string (date-time)
  The date the risk was added to the project.
• impactedDate: string (date-time)
  The date the risk impacted the project.
• impacts: array impacts
  The impact of the risk.
• latitude: number (double)
  Minimum Value: -90

  Maximum Value: 90

  The geographical coordinate for the latitude of the location.
  The default format for latitude is decimal degrees format, but the format you need to use will depend on your geolocation service.
• locationName: string
  Minimum Length: 0

  Maximum Length: 255

  A name for the location that your users will understand and recognize.
• longitude: number (double)
  Minimum Value: -180

  Maximum Value: 180

  The geographical coordinate for the longitude of the location.
  The default format for longitude is decimal degrees format, but the format you need to use will depend on your geolocation service.
• ownerId: integer (int64)
  The name of the user who is assigned to manage the risk.
• postalCode: string
  Minimum Length: 0

  Maximum Length: 20

  The postal code, post code, or zip code of a location.
• probabilityImpactQuantified: boolean
  When selected, the quantified probability distribution is used to determine the probability that the risk occurs for each iteration.
• projectCode: string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId(required): integer (int64)
  The unique identifier for the project to which the risk was added.
• projectRiskFinancial: projectRiskFinancial
  The financial fields associated with a project risk.
• projectRiskId: integer (int64)
  The system-generated identifier of the project risk.
• projectRiskStatus: string
  Allowed Values: [ "PROPOSED", "OPEN", "MONITORING", "IMPACTING", "REJECTED", "CANNOT_IMPACT", "IMPACTED" ]

  The status of the risk.
  Proposed: The risk is identified and awaits approval.
  Open: The risk is approved as a valid risk and is awaiting management.
  Monitoring: The risk has been managed and is being monitored.
  Impacting: The risk is currently impacting the project.
  Cannot Impact: The risk did not happen and can no longer happen.
  Impacted: The risk occurred.
  Rejected: The risk is not seen as a valid risk to the project and therefore will not be tracked and managed by the project.
• riskCode: string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for the risk.
• riskFactorCostImpactOption: string
  Default Value: ALL_COSTS

  Allowed Values: [ "ALL_COSTS", "MATERIAL_COSTS_ONLY", "LABOR_COSTS_ONLY", "NONLABOR_COSTS_ONLY", "LABOR_AND_NONLABOR_COSTS_ONLY" ]

  The cost type the risk factor impacts.
• riskName(required): string
  Minimum Length: 0

  Maximum Length: 255

  The name of the risk.
• riskQuantifiedCostImpact: riskQuantifiedCostImpact
  The impact this risk will have on cost data.
• riskQuantifiedOtherImpacts: array riskQuantifiedOtherImpacts
  The impact this risk will have on other data.
• riskType: string
  Allowed Values: [ "THREAT", "OPPORTUNITY", "WEATHER", "RISK_FACTOR" ]

  The type of risk. Valid values are Threat, Opportunity, Weather and Risk Factor.
• scheduleImpactQuantified: boolean
  When selected, the quantified schedule impact distribution is used to calculate the schedule impact size for each iteration.
• state: string
  Minimum Length: 0

  Maximum Length: 200

  The state, region, or province of a location.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.

{
    "title":"ApiEntityProjectRiskInput",
    "required":[
        "projectId",
        "riskName"
    ],
    "type":"object",
    "properties":{
        "costCategoryId":{
            "type":"integer",
            "description":"The category name used to organize and define the cost.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "cbsCodes":{
            "type":"array",
            "description":"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.",
            "writeOnly":true,
            "exampleSetFlag":false,
            "items":{
                "type":"string",
                "writeOnly":true,
                "exampleSetFlag":false,
                "types":[
                    "string"
                ]
            },
            "types":[
                "array"
            ]
        },
        "codeValuesRisk":{
            "type":"array",
            "description":"The list of code values for a project risk. This entity can only be used to assign codeValues or create codeValues on the fly.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityCodeValueRiskInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "impacts":{
            "type":"array",
            "description":"The impact of the risk.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityRiskImpactInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "riskQuantifiedOtherImpacts":{
            "type":"array",
            "description":"The impact this risk will have on other data.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityRiskQuantifiedOtherImpactInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "projectRiskStatus":{
            "type":"string",
            "description":"The status of the risk. <br />Proposed: The risk is identified and awaits approval. <br />Open: The risk is approved as a valid risk and is awaiting management. <br />Monitoring: The risk has been managed and is being monitored. <br />Impacting: The risk is currently impacting the project. <br />Cannot Impact: The risk did not happen and can no longer happen. <br />Impacted: The risk occurred. <br />Rejected: The risk is not seen as a valid risk to the project and therefore will not be tracked and managed by the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "PROPOSED",
                "OPEN",
                "MONITORING",
                "IMPACTING",
                "REJECTED",
                "CANNOT_IMPACT",
                "IMPACTED"
            ]
        },
        "riskFactorCostImpactOption":{
            "type":"string",
            "description":"The cost type the risk factor impacts.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "default":"ALL_COSTS",
            "enum":[
                "ALL_COSTS",
                "MATERIAL_COSTS_ONLY",
                "LABOR_COSTS_ONLY",
                "NONLABOR_COSTS_ONLY",
                "LABOR_AND_NONLABOR_COSTS_ONLY"
            ]
        },
        "excludeFromRiskRemovalAnalysis":{
            "type":"boolean",
            "description":"Determines whether the impact of removing the risk is calculated during risk removal risk analysis.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ],
            "default":false
        },
        "configuredFields":{
            "type":"array",
            "description":"The list of configured fields for a project risk.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityProjectRiskConfiguredFieldValueInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "projectRiskId":{
            "type":"integer",
            "description":"The system-generated identifier of the project risk.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectRiskFinancial":{
            "description":"The financial fields associated with a project risk.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityProjectRiskFinancialInput"
                }
            ]
        },
        "riskQuantifiedCostImpact":{
            "description":"The impact this risk will have on cost data.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityRiskQuantifiedCostImpactInput"
                }
            ]
        },
        "cbsSheetCodeId":{
            "type":"integer",
            "description":"The cost breakdown structure code assigned to the risk.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project to which the risk was added.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "riskCode":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The unique identifier for the risk.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceCode":{
            "maxLength":60,
            "minLength":0,
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "cause":{
            "maxLength":4000,
            "minLength":0,
            "type":"string",
            "description":"A description of the cause of the risk.",
            "exampleSetFlag":false
        },
        "state":{
            "maxLength":200,
            "minLength":0,
            "type":"string",
            "description":"The state, region, or province of a location.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "country":{
            "maxLength":3,
            "minLength":0,
            "type":"string",
            "description":"The country for a location.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "city":{
            "maxLength":200,
            "minLength":0,
            "type":"string",
            "description":"The city name for a location.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "description":{
            "maxLength":4000,
            "minLength":0,
            "type":"string",
            "description":"A detailed summary of the risk.",
            "exampleSetFlag":false
        },
        "identifiedById":{
            "type":"integer",
            "description":"The user who added the risk to the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "identifiedDate":{
            "type":"string",
            "description":"The date the risk was added to the project.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "effect":{
            "maxLength":4000,
            "minLength":0,
            "type":"string",
            "description":"The resulting effect of the presence of the risk.",
            "exampleSetFlag":false
        },
        "riskType":{
            "type":"string",
            "description":"The type of risk. Valid values are Threat, Opportunity, Weather and Risk Factor.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "THREAT",
                "OPPORTUNITY",
                "WEATHER",
                "RISK_FACTOR"
            ]
        },
        "impactedDate":{
            "type":"string",
            "description":"The date the risk impacted the project.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "riskName":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"The name of the risk.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "addressLine1":{
            "maxLength":200,
            "minLength":0,
            "type":"string",
            "description":"The first line of the address of a location. <br />This might be the building number and street address.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "addressLine2":{
            "maxLength":200,
            "minLength":0,
            "type":"string",
            "description":"The second line of the address of a location. <br />This might be a neighborhood or town.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "postalCode":{
            "maxLength":20,
            "minLength":0,
            "type":"string",
            "description":"The postal code, post code, or zip code of a location.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "longitude":{
            "maximum":180,
            "minimum":-180,
            "type":"number",
            "description":"The geographical coordinate for the longitude of the location. <br />The default format for longitude is decimal degrees format, but the format you need to use will depend on your geolocation service.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "latitude":{
            "maximum":90,
            "minimum":-90,
            "type":"number",
            "description":"The geographical coordinate for the latitude of the location. <br />The default format for latitude is decimal degrees format, but the format you need to use will depend on your geolocation service.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "hasPostResponseData":{
            "type":"boolean",
            "description":"Determines whether this risk has post-response values.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "actualScheduleImpact":{
            "type":"number",
            "description":"The actual schedule impact due to the risk occurring.",
            "format":"double",
            "exampleSetFlag":false
        },
        "costImpactQuantified":{
            "type":"boolean",
            "description":"When selected, the quantified cost distribution is used to determine the cost impact for each iteration.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "probabilityImpactQuantified":{
            "type":"boolean",
            "description":"When selected, the quantified probability distribution is used to determine the probability that the risk occurs for each iteration.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "scheduleImpactQuantified":{
            "type":"boolean",
            "description":"When selected, the quantified schedule impact distribution is used to calculate the schedule impact size for each iteration.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "locationName":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"A name for the location that your users will understand and recognize.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "ownerId":{
            "type":"integer",
            "description":"The name of the user who is assigned to manage the risk.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "description":"This entity represents a ProjectRisk object, a unique ProjectRisk object can be identified by the following combinations of the fields.<ul><li>projectRiskId</li><li>riskCode,projectId</li><li>riskCode,projectCode,workspaceCode</li>",
    "exampleSetFlag":false
}

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

• Array of: string

{
    "type":"array",
    "description":"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.",
    "writeOnly":true,
    "exampleSetFlag":false,
    "items":{
        "type":"string",
        "writeOnly":true,
        "exampleSetFlag":false,
        "types":[
            "string"
        ]
    },
    "types":[
        "array"
    ]
}

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

• Array of: object 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

{
    "type":"array",
    "description":"The list of code values for a project risk. This entity can only be used to assign codeValues or create codeValues on the fly.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityCodeValueRiskInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : configuredFields

Type: array

The list of configured fields for a project risk.

Show Source

• Array of: object 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

{
    "type":"array",
    "description":"The list of configured fields for a project risk.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityProjectRiskConfiguredFieldValueInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : impacts

Type: array

The impact of the risk.

Show Source

• Array of: object ApiEntityRiskImpactInput
  Title: ApiEntityRiskImpactInput

{
    "type":"array",
    "description":"The impact of the risk.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityRiskImpactInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : projectRiskFinancial

The financial fields associated with a project risk.

Match All

The financial fields associated with a project risk.

Show Source

• object ApiEntityProjectRiskFinancialInput
  Title: ApiEntityProjectRiskFinancialInput

{
    "description":"The financial fields associated with a project risk.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityProjectRiskFinancialInput"
        }
    ]
}

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

• object ApiEntityRiskQuantifiedCostImpactInput
  Title: ApiEntityRiskQuantifiedCostImpactInput

{
    "description":"The impact this risk will have on cost data.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityRiskQuantifiedCostImpactInput"
        }
    ]
}

Nested Schema : riskQuantifiedOtherImpacts

Type: array

The impact this risk will have on other data.

Show Source

• Array of: object ApiEntityRiskQuantifiedOtherImpactInput
  Title: ApiEntityRiskQuantifiedOtherImpactInput

{
    "type":"array",
    "description":"The impact this risk will have on other data.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityRiskQuantifiedOtherImpactInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

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

• action: string
  Allowed Values: [ "DELETE" ]

  Provide a value for this field during object update to delete code value assigned to the object.
• codeTypeCode: string
  Minimum Length: 0

  Maximum Length: 60

  This field displays the name of a code or value.
• codeTypeId(required): integer (int64)
  The unique identifier for the code type.The code type object can also be identified by its unique criteria.
• codeValueCode(required): string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for the code value.
• codeValueId: integer (int64)
  The unique identifier for the code value.
• codeValueName: string
  Minimum Length: 1

  Maximum Length: 255

  The name of the code value.
• codeValueRiskId: integer (int64)
  The unique identifier of a risk code value.
• parentId: integer (int64)
  The unique identifier of a parent code value.
• projectCode: string
  Minimum Length: 1

  Maximum Length: 60

  The code of a Project of a Project CodeType.
• projectId: integer (int64)
  The unique identifier for the project.The project object can also be identified by its unique criteria.
• projectRiskId: integer (int64)
  The unique identifier of a project.

{
    "title":"ApiEntityCodeValueRiskInput",
    "required":[
        "codeTypeId",
        "codeValueCode"
    ],
    "type":"object",
    "properties":{
        "codeValueRiskId":{
            "type":"integer",
            "description":"The unique identifier of a risk code value.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectRiskId":{
            "type":"integer",
            "description":"The unique identifier of a project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeTypeId":{
            "type":"integer",
            "description":"The unique identifier for the code type.The code type object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeTypeCode":{
            "maxLength":60,
            "minLength":0,
            "type":"string",
            "description":"This field displays the name of a code or value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "codeValueId":{
            "type":"integer",
            "description":"The unique identifier for the code value.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeValueName":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"The name of the code value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "codeValueCode":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The unique identifier for the code value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "parentId":{
            "type":"integer",
            "description":"The unique identifier of a parent code value.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "action":{
            "type":"string",
            "description":"Provide a value for this field during object update to delete code value assigned to the object.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DELETE"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The code of a Project of a Project CodeType.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a CodeValueRisk object, a unique CodeValueRisk object can be identified by the following combinations of the fields.<ul><li>codeValueRiskId</li><li>codeValueId</li><li>codeTypeId,codeValueCode</li><li>codeTypeCode,codeValueCode</li><li>codeTypeCode,parentId,codeValueCode</li><li>codeValueCode,codeTypeId,parentId</li><li>codeTypeCode,codeValueCode,projectCode</li><li>codeTypeCode,codeValueCode,projectId</li><li>codeTypeCode,codeValueCode,parentId,projectCode</li><li>codeTypeCode,codeValueCode,parentId,projectId</li>",
    "exampleSetFlag":false
}

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

• action: string
  Allowed Values: [ "DELETE" ]

  Provide value for this field during object update to delete the assigned configured field value.
• columnDefinitionId: integer (int64)
  Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.
• columnLabel: string
  Minimum Length: 1

  Maximum Length: 100

  The user-specified UDF column label.
• columnName: string
  Minimum Length: 1

  Maximum Length: 100

  The user-specified UDF column name.
• dateValue: string (date-time)
  This holds values for Date type configured fields.
• numberValue: number
  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.
• projectRiskConfiguredFieldValueId: integer (int64)
  The unique identifier for the Risk Configured Field.
• projectRiskId: integer (int64)
  The system-generated identifier of a Risk.
• textValue: string
  Maximum Length: 4000

  This holds values for Boolean, List and Text type configured fields.

{
    "title":"ApiEntityProjectRiskConfiguredFieldValueInput",
    "type":"object",
    "properties":{
        "projectRiskConfiguredFieldValueId":{
            "type":"integer",
            "description":"The unique identifier for the Risk Configured Field.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectRiskId":{
            "type":"integer",
            "description":"The system-generated identifier of a Risk.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "columnDefinitionId":{
            "type":"integer",
            "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "numberValue":{
            "type":"number",
            "description":"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.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "columnLabel":{
            "maxLength":100,
            "minLength":1,
            "type":"string",
            "description":"The user-specified UDF column label.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "textValue":{
            "maxLength":4000,
            "type":"string",
            "description":"This holds values for Boolean, List and Text type configured fields.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "columnName":{
            "maxLength":100,
            "minLength":1,
            "type":"string",
            "description":"The user-specified UDF column name.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "dateValue":{
            "type":"string",
            "description":"This holds values for Date type configured fields.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "action":{
            "type":"string",
            "description":"Provide value for this field during object update to delete the assigned configured field value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DELETE"
            ]
        }
    },
    "description":"This entity represents a ProjectRiskConfiguredFieldValue object, a unique ProjectRiskConfiguredFieldValue object can be identified by the following combinations of the fields.<ul><li>projectRiskConfiguredFieldValueId</li><li>columnDefinitionId</li><li>columnName</li><li>columnLabel</li>",
    "exampleSetFlag":false
}

Nested Schema : ApiEntityRiskImpactInput

Type: object

Title: ApiEntityRiskImpactInput

Show Source

• postRiskScoreThresholdCode: string
  Minimum Length: 0

  Maximum Length: 60

  The unique identifier for the risk scoring threshold.
• postRiskScoreThresholdId: integer (int64)
  The system-generated unique identifier for the post-response impact threshold.
• projectRiskId(required): integer (int64)
  The system-generated unique identifier of the project risk.
• riskImpactId: integer (int64)
  A database generated unique value for the object that links the RSK_PROJECT to the selected threshold. It also includes the score type.
• riskScoreThresholdCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of the risk score threshold of a risk impact.
• riskScoreThresholdId(required): integer (int64)
  The system-generated unique identifier for the pre-response impact threshold.
• riskScoreTypeId(required): integer (int64)
  The system-generated unique identifier of the risk score type.
• riskScoreTypeName: string
  Minimum Length: 0

  Maximum Length: 255

  The risk score type name of a risk impact.

{
    "title":"ApiEntityRiskImpactInput",
    "required":[
        "projectRiskId",
        "riskScoreThresholdId",
        "riskScoreTypeId"
    ],
    "type":"object",
    "properties":{
        "projectRiskId":{
            "type":"integer",
            "description":"The system-generated unique identifier of the project risk.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "riskScoreTypeId":{
            "type":"integer",
            "description":"The system-generated unique identifier of the risk score type.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "riskImpactId":{
            "type":"integer",
            "description":"A database generated unique value for the object that links the RSK_PROJECT to the selected threshold. It also includes the score type.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "riskScoreThresholdCode":{
            "maxLength":60,
            "minLength":0,
            "type":"string",
            "description":"The user-specified identifier of the risk score threshold of a risk impact.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "postRiskScoreThresholdCode":{
            "maxLength":60,
            "minLength":0,
            "type":"string",
            "description":"The unique identifier for the risk scoring threshold.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "postRiskScoreThresholdId":{
            "type":"integer",
            "description":"The system-generated unique identifier for the post-response impact threshold.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "riskScoreTypeName":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"The risk score type name of a risk impact.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "riskScoreThresholdId":{
            "type":"integer",
            "description":"The system-generated unique identifier for the pre-response impact threshold.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityProjectRiskFinancialInput

Type: object

Title: ApiEntityProjectRiskFinancialInput

Show Source

• actualCostImpact: number (double)
  Minimum Value: 0

  The actual cost impact due to the risk occurring.
• contingency: number (double)
  Minimum Value: 0

  The allowable risk cost should the risk occur.
• projectRiskId(required): integer (int64)
  The unique identifier of a project risk.

{
    "title":"ApiEntityProjectRiskFinancialInput",
    "required":[
        "projectRiskId"
    ],
    "type":"object",
    "properties":{
        "contingency":{
            "minimum":0,
            "type":"number",
            "description":"The allowable risk cost should the risk occur.",
            "format":"double",
            "exampleSetFlag":false
        },
        "projectRiskId":{
            "type":"integer",
            "description":"The unique identifier of a project risk.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "actualCostImpact":{
            "minimum":0,
            "type":"number",
            "description":"The actual cost impact due to the risk occurring.",
            "format":"double",
            "exampleSetFlag":false
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityRiskQuantifiedCostImpactInput

Type: object

Title: ApiEntityRiskQuantifiedCostImpactInput

Show Source

• postResponseDistributionShape: string
  Allowed Values: [ "SINGLE_POINT", "TRIANGLE", "UNIFORM", "BETAPERT" ]

  Determines the distribution that best models the three-point estimates for the cost impact after a response.
• postResponseMaximum: number (double)
  The maximum cost of responding to a risk event. This field is in base currency and is calculated from postResponseMaximumProject field based on the specified exchange rate.
• postResponseMinimum: number (double)
  The minimum cost of responding to a risk event that has occurred. This field is in base currency and is calculated from postResponseMinimumProject field based on the specified exchange rate.
• postResponseMostLikely: number (double)
  The most likely cost of a risk event that has occurred. This field is in base currency and is calculated from postResponseMostLikelyProject field based on the specified exchange rate.
• preResponseDistributionShape(required): string
  Allowed Values: [ "SINGLE_POINT", "TRIANGLE", "UNIFORM", "BETAPERT" ]

  Determines the distribution that best models the three-point estimates for the cost impact before a response.
• preResponseMaximum: number (double)
  The maximum cost of preparing for a risk event that has not occurred. This field is in base currency and is calculated from preResponseMaximumProject field based on the specified exchange rate.
• preResponseMinimum: number (double)
  The minimum cost of preparing for a risk event that has not occurred. This field is in base currency and is calculated from preResponseMinimumProject field based on the specified exchange rate.
• preResponseMostLikely: number (double)
  The most likely cost of preparing for a risk event that has not occurred. This field is in base currency and is calculated from preResponseMostLikelyProject field based on the specified exchange rate.
• projectRiskId(required): integer (int64)
  The unique identifier of a project.
• quantifiedCostImpactId: integer (int64)
  The unique identifier of a cost impact.

{
    "title":"ApiEntityRiskQuantifiedCostImpactInput",
    "required":[
        "preResponseDistributionShape",
        "projectRiskId"
    ],
    "type":"object",
    "properties":{
        "projectRiskId":{
            "type":"integer",
            "description":"The unique identifier of a project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "preResponseMinimum":{
            "type":"number",
            "description":"The minimum cost of preparing for a risk event that has not occurred. This field is in base currency and is calculated from preResponseMinimumProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "preResponseMostLikely":{
            "type":"number",
            "description":"The most likely cost of preparing for a risk event that has not occurred. This field is in base currency and is calculated from preResponseMostLikelyProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "preResponseMaximum":{
            "type":"number",
            "description":"The maximum cost of preparing for a risk event that has not occurred. This field is in base currency and is calculated from preResponseMaximumProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "postResponseMinimum":{
            "type":"number",
            "description":"The minimum cost of responding to a risk event that has occurred. This field is in base currency and is calculated from postResponseMinimumProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "postResponseMostLikely":{
            "type":"number",
            "description":"The most likely cost of a risk event that has occurred. This field is in base currency and is calculated from postResponseMostLikelyProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "postResponseMaximum":{
            "type":"number",
            "description":"The maximum cost of responding to a risk event. This field is in base currency and is calculated from postResponseMaximumProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "preResponseDistributionShape":{
            "type":"string",
            "description":"Determines the distribution that best models the three-point estimates for the cost impact before a response. ",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "SINGLE_POINT",
                "TRIANGLE",
                "UNIFORM",
                "BETAPERT"
            ]
        },
        "quantifiedCostImpactId":{
            "type":"integer",
            "description":"The unique identifier of a cost impact.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "postResponseDistributionShape":{
            "type":"string",
            "description":"Determines the distribution that best models the three-point estimates for the cost impact after a response.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "SINGLE_POINT",
                "TRIANGLE",
                "UNIFORM",
                "BETAPERT"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityRiskQuantifiedOtherImpactInput

Type: object

Title: ApiEntityRiskQuantifiedOtherImpactInput

Show Source

• maximum: number (double)
  The maximum probability that a risk event will occur.
• minimum: number (double)
  The minimum probability that a risk event will occur.
• mostLikely: number (double)
  The most likely probability that a risk event will occur.
• preOrPostResponse: string
  Allowed Values: [ "PRE_RESPONSE", "POST_RESPONSE" ]

  Indicates whether a risk impact is measured pre or post response.
• projectRiskId(required): integer (int64)
  The unique identifier of a project.
• quantifiedOtherImpactId(required): integer (int64)
  The unique identifier of a risk impact.
• scoreType: string
  Allowed Values: [ "PROBABILITY", "SCHEDULE", "RELATIVE_SCHEDULE", "COST", "RELATIVE_COST", "USER" ]

  The type of an impact score.
• shape(required): string
  Allowed Values: [ "SINGLE_POINT", "TRIANGLE", "UNIFORM", "BETAPERT" ]

  The distribution that best models the three-point estimates for risk probabilities or risk schedule impacts.

{
    "title":"ApiEntityRiskQuantifiedOtherImpactInput",
    "required":[
        "projectRiskId",
        "quantifiedOtherImpactId",
        "shape"
    ],
    "type":"object",
    "properties":{
        "projectRiskId":{
            "type":"integer",
            "description":"The unique identifier of a project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "minimum":{
            "type":"number",
            "description":"The minimum probability that a risk event will occur.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "maximum":{
            "type":"number",
            "description":"The maximum probability that a risk event will occur.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "shape":{
            "type":"string",
            "description":"The distribution that best models the three-point estimates for risk probabilities or risk schedule impacts.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "SINGLE_POINT",
                "TRIANGLE",
                "UNIFORM",
                "BETAPERT"
            ]
        },
        "scoreType":{
            "type":"string",
            "description":"The type of an impact score.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "PROBABILITY",
                "SCHEDULE",
                "RELATIVE_SCHEDULE",
                "COST",
                "RELATIVE_COST",
                "USER"
            ]
        },
        "mostLikely":{
            "type":"number",
            "description":"The most likely probability that a risk event will occur.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "quantifiedOtherImpactId":{
            "type":"integer",
            "description":"The unique identifier of a risk impact.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "preOrPostResponse":{
            "type":"string",
            "description":"Indicates whether a risk impact is measured pre or post response.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "PRE_RESPONSE",
                "POST_RESPONSE"
            ]
        }
    },
    "exampleSetFlag":false
}

Examples

Select an example Batch Update Project Risks by Assigning Hierarchical Code Values Using Codes Batch Update Project Risks Using Project Risk IDs Batch Update Project Risks by Assigning Code Values Using Codes or IDs

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