Jump to

• Request
• Response

View all Project Risks by Assigned CodeValue

get

/api/restapi/projectRisk/codeType/{codeTypeId}/codeValue/{codeValueCode}

This endpoint returns project risks that meet the following requirements:

• The object is assigned a code type that matches the value of the {codeTypeId} path parameter with a value that matches the value of the {codeValueCode} path parameter.

Request

Path Parameters

• codeTypeId(required): integer(int64)
  The system-generated identifier of a code type.
• codeValueCode(required): string
  The user-specified identifier of a code value.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : List<ApiEntityProjectRisk>

Type: array

Title: List<ApiEntityProjectRisk>

Show Source

• Array of: object ApiEntityProjectRisk
  Title: ApiEntityProjectRisk

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

Nested Schema : ApiEntityProjectRisk

Type: object

Title: ApiEntityProjectRisk

Show Source

• activityImpactQuantified: boolean
  Enabled when activity quantified risk impact is linked to the project.
• 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
  Deprecated. As of 23.11.
  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.
• exposureFinishDate: string (date-time)
  The latest finish date of the activities the risk is mapped to. If the risk is not mapped to any activities, it is the project scheduled finish date.
• exposureStartDate: string (date-time)
  The earliest start date of the activities that the risk is mapped to. If the risk is not mapped to any activities, it is the date at which the schedule is progressed (Data Date).
• 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.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• 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.
• postResponseMeanCostImpact: number (double)
  The estimated average project cost impact before implementing a response action.
• postResponseMeanDelay: number (double)
  The estimated average project delay duration before implementing a response action.
• postResponsePessimisticCostDeltaAbs: number (double)
  The cost difference between the Pre-Response and Post-Response remaining cost values.
• postResponsePessimisticFinishDeltaAbs: number (double)
  The duration difference between the pre-response and post-response pessimistic finish dates.
• postScore: integer (int32)
  The post-response risk score calculated using the project risk matrix.
• preResponseMeanCostImpact: number (double)
  The estimated average project cost impact before implementing a response action.
• preResponseMeanDelay: number (double)
  The estimated average project delay duration before implementing a response action.
• preResponsePessimisticCostDeltaAbs: number (double)
  The cost difference between the Pre-Response and Post-Response remaining cost values.
• preResponsePessimisticFinishDeltaAbs: number (double)
  The duration difference between the pre-response and post-response pessimistic finish dates.
• 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: 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.
• quantifiedPostResponseProbabilityThreshold: number (double)
  The probability threshold that a risk will occur after implementing a response action.
• quantifiedPostResponseScheduleThreshold: number (double)
  The estimated impact size that the risk will have on the project schedule after implementing a response action.
• quantifiedProbabilityThreshold: number (double)
  The estimated probability that a risk will occur before implementing a response action.
• quantifiedScheduleThreshold: number (double)
  The estimated impact size that the risk will have on the project schedule before implementing a response action.
• responseEffectiveness: number (double)
  The effectiveness of the risk's response actions expressed as a ratio of the Exposure Improvement and the Total At Completion Response Cost.
• riskCode: string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for the risk.
• riskName: 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.
• riskSourceType: string
  Allowed Values: [ "PROJECT", "PROGRAM" ]

  The source type of the risk i.e. Project or Program.
• riskType: string
  Allowed Values: [ "THREAT", "OPPORTUNITY", "WEATHER" ]

  The type of risk. Valid values are Threat, Opportunity and Weather.
• scheduleImpactQuantified: boolean
  When selected, the quantified schedule impact distribution is used to calculate the schedule impact size for each iteration.
• score: integer (int32)
  The pre-response risk score calculated using the project risk matrix.
• scoreImprovement: integer (int32)
  The change in project risk score due to the response action(s).
• state: string
  Minimum Length: 0

  Maximum Length: 200

  The state, region, or province of a location.
• 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.
• workspaceId: integer (int64)
  The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.

{
    "title":"ApiEntityProjectRisk",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "cbsCodes":{
            "type":"array",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>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,
            "deprecated":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/ApiEntityCodeValueRisk",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "configuredFields":{
            "type":"array",
            "description":"The list of configured fields for a project risk.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityProjectRiskConfiguredFieldValue",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "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"
            ]
        },
        "projectRiskFinancial":{
            "description":"The financial fields associated with a project risk.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityProjectRiskFinancial"
                }
            ]
        },
        "riskQuantifiedCostImpact":{
            "description":"The impact this risk will have on cost data.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityRiskQuantifiedCostImpact"
                }
            ]
        },
        "projectRiskId":{
            "type":"integer",
            "description":"The system-generated identifier of the project risk.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "cbsSheetCodeId":{
            "type":"integer",
            "description":"The cost breakdown structure code assigned to the risk.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "costCategoryId":{
            "type":"integer",
            "description":"The category name used to organize and define the cost.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "impacts":{
            "type":"array",
            "description":"The impact of the risk.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityRiskImpact",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "riskQuantifiedOtherImpacts":{
            "type":"array",
            "description":"The impact this risk will have on other data.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityRiskQuantifiedOtherImpact",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "activityImpactQuantified":{
            "type":"boolean",
            "description":"Enabled when activity quantified risk impact is linked to the project.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "preResponseMeanCostImpact":{
            "type":"number",
            "description":"The estimated average project cost impact before implementing a response action.",
            "format":"double",
            "exampleSetFlag":false
        },
        "postResponseMeanCostImpact":{
            "type":"number",
            "description":"The estimated average project cost impact before implementing a response action.",
            "format":"double",
            "exampleSetFlag":false
        },
        "preResponsePessimisticFinishDeltaAbs":{
            "type":"number",
            "description":"The duration difference between the pre-response and post-response pessimistic finish dates.",
            "format":"double",
            "exampleSetFlag":false
        },
        "postResponsePessimisticFinishDeltaAbs":{
            "type":"number",
            "description":"The duration difference between the pre-response and post-response pessimistic finish dates.",
            "format":"double",
            "exampleSetFlag":false
        },
        "preResponsePessimisticCostDeltaAbs":{
            "type":"number",
            "description":"The cost difference between the Pre-Response and Post-Response remaining cost values.",
            "format":"double",
            "exampleSetFlag":false
        },
        "postResponsePessimisticCostDeltaAbs":{
            "type":"number",
            "description":"The cost difference between the Pre-Response and Post-Response remaining cost values.",
            "format":"double",
            "exampleSetFlag":false
        },
        "exposureStartDate":{
            "type":"string",
            "description":"The earliest start date of the activities that the risk is mapped to. If the risk is not mapped to any activities, it is the date at which the schedule is progressed (Data Date).",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "exposureFinishDate":{
            "type":"string",
            "description":"The latest finish date of the activities the risk is mapped to. If the risk is not mapped to any activities, it is the project scheduled finish date.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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
        },
        "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"
            ]
        },
        "riskCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The unique identifier for the risk.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "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"
            ]
        },
        "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"
            ]
        },
        "description":{
            "maxLength":"4000",
            "minLength":"0",
            "type":"string",
            "description":"A detailed summary of the risk.",
            "exampleSetFlag":false
        },
        "city":{
            "maxLength":"200",
            "minLength":"0",
            "type":"string",
            "description":"The city name for a location.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "hasPostResponseData":{
            "type":"boolean",
            "description":"Determines whether this risk has post-response values.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "identifiedDate":{
            "type":"string",
            "description":"The date the risk was added to the project.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "riskType":{
            "type":"string",
            "description":"The type of risk. Valid values are Threat, Opportunity and Weather.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "THREAT",
                "OPPORTUNITY",
                "WEATHER"
            ]
        },
        "identifiedById":{
            "type":"integer",
            "description":"The user who added the risk to the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "effect":{
            "maxLength":"4000",
            "minLength":"0",
            "type":"string",
            "description":"The resulting effect of the presence of the risk.",
            "exampleSetFlag":false
        },
        "score":{
            "type":"integer",
            "description":"The pre-response risk score calculated using the project risk matrix.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "postScore":{
            "type":"integer",
            "description":"The post-response risk score calculated using the project risk matrix.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "costImpactQuantified":{
            "type":"boolean",
            "description":"When selected, the quantified cost distribution is used to determine the cost impact 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"
            ]
        },
        "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"
            ]
        },
        "quantifiedScheduleThreshold":{
            "type":"number",
            "description":"The estimated impact size that the risk will have on the project schedule before implementing a response action.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "quantifiedProbabilityThreshold":{
            "type":"number",
            "description":"The estimated probability that a risk will occur before implementing a response action.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "quantifiedPostResponseScheduleThreshold":{
            "type":"number",
            "description":"The estimated impact size that the risk will have on the project schedule after implementing a response action.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "quantifiedPostResponseProbabilityThreshold":{
            "type":"number",
            "description":"The probability threshold that a risk will occur after implementing a response action.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "actualScheduleImpact":{
            "type":"number",
            "description":"The actual schedule impact due to the risk occurring.",
            "format":"double",
            "exampleSetFlag":false
        },
        "impactedDate":{
            "type":"string",
            "description":"The date the risk impacted the project.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "preResponseMeanDelay":{
            "type":"number",
            "description":"The estimated average project delay duration before implementing a response action.",
            "format":"double",
            "exampleSetFlag":false
        },
        "postResponseMeanDelay":{
            "type":"number",
            "description":"The estimated average project delay duration before implementing a response action.",
            "format":"double",
            "exampleSetFlag":false
        },
        "riskSourceType":{
            "type":"string",
            "description":"The source type of the risk i.e. Project or Program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "PROJECT",
                "PROGRAM"
            ]
        },
        "scoreImprovement":{
            "type":"integer",
            "description":"The change in project risk score due to the response action(s).",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "responseEffectiveness":{
            "type":"number",
            "description":"The effectiveness of the risk's response actions expressed as a ratio of the Exposure Improvement and the Total At Completion Response Cost.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : cbsCodes

Type: array

Deprecated. As of 23.11.
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":"<b>Deprecated.</b> As of <i>23.11</i>.</br>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,
    "deprecated":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 ApiEntityCodeValueRisk
  Title: ApiEntityCodeValueRisk

{
    "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/ApiEntityCodeValueRisk",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : configuredFields

Type: array

The list of configured fields for a project risk.

Show Source

• Array of: object ApiEntityProjectRiskConfiguredFieldValue
  Title: ApiEntityProjectRiskConfiguredFieldValue

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

Nested Schema : impacts

Type: array

The impact of the risk.

Show Source

• Array of: object ApiEntityRiskImpact
  Title: ApiEntityRiskImpact

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

Nested Schema : projectRiskFinancial

The financial fields associated with a project risk.

Match All

Show Source

• object ApiEntityProjectRiskFinancial
  Title: ApiEntityProjectRiskFinancial

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

Nested Schema : riskQuantifiedCostImpact

The impact this risk will have on cost data.

Match All

Show Source

• object ApiEntityRiskQuantifiedCostImpact
  Title: ApiEntityRiskQuantifiedCostImpact

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

Nested Schema : riskQuantifiedOtherImpacts

Type: array

The impact this risk will have on other data.

Show Source

• Array of: object ApiEntityRiskQuantifiedOtherImpact
  Title: ApiEntityRiskQuantifiedOtherImpact

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

Nested Schema : ApiEntityCodeValueRisk

Type: object

Title: ApiEntityCodeValueRisk

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.
• codeTypeName: string
  Minimum Length: 0

  Maximum Length: 255

  The name of a code or value.
• 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.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• 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.
• sequenceNumber: integer (int32)
  The number that specifies the position of the code value item within the code type list.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityCodeValueRisk",
    "required":[
        "codeTypeId",
        "codeValueCode"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectRiskId":{
            "type":"integer",
            "description":"The unique identifier of a project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeValueRiskId":{
            "type":"integer",
            "description":"The unique identifier of a risk code value.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "sequenceNumber":{
            "type":"integer",
            "description":"The number that specifies the position of the code value item within the code type list.",
            "format":"int32",
            "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"
            ]
        },
        "parentId":{
            "type":"integer",
            "description":"The unique identifier of a parent code value.",
            "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"
            ]
        },
        "codeTypeName":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string",
            "description":"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"
            ]
        },
        "codeValueCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The unique identifier for the code value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "codeValueName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the code value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityProjectRiskConfiguredFieldValue

Type: object

Title: ApiEntityProjectRiskConfiguredFieldValue

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.
• costValue: number
  This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.
• costValueWorkspace1: number (double)
  This holds values for Cost type configured fields in the workspace1 currency conversion.
• costValueWorkspace2: number (double)
  This holds values for Cost type configured fields in the workspace2 currency conversion.
• costValueWorkspace3: number (double)
  This holds values for Cost type configured fields in the workspace3 currency conversion.
• dateValue: string (date-time)
  This holds values for Date type configured fields.
• exceptionMessage: string
  Maximum Length: 4000

  Provides the error message for why the formula calculation resulted in an error.
• hasException: boolean
  Determines if formula calculation hit an error calculating a value for this field.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• 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.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityProjectRiskConfiguredFieldValue",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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"
            ]
        },
        "columnName":{
            "maxLength":"100",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified UDF column name.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "textValue":{
            "maxLength":"4000",
            "type":"string",
            "description":"This holds values for Boolean, List and Text type configured fields.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "dateValue":{
            "type":"string",
            "description":"This holds values for Date type configured fields.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "costValue":{
            "type":"number",
            "description":"This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "hasException":{
            "type":"boolean",
            "description":"Determines if formula calculation hit an error calculating a value for this field.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "exceptionMessage":{
            "maxLength":"4000",
            "type":"string",
            "description":"Provides the error message for why the formula calculation resulted in an error.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "costValueWorkspace1":{
            "type":"number",
            "description":"This holds values for Cost type configured fields in the workspace1 currency conversion.",
            "format":"double",
            "exampleSetFlag":false
        },
        "costValueWorkspace2":{
            "type":"number",
            "description":"This holds values for Cost type configured fields in the workspace2 currency conversion.",
            "format":"double",
            "exampleSetFlag":false
        },
        "costValueWorkspace3":{
            "type":"number",
            "description":"This holds values for Cost type configured fields in the workspace3 currency conversion.",
            "format":"double",
            "exampleSetFlag":false
        },
        "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"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityRiskImpact

Type: object

Title: ApiEntityRiskImpact

Show Source

• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• 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.
• projectCode: string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectRiskId: integer (int64)
  The system-generated unique identifier of the project risk.
• riskCode: string
  Minimum Length: 1

  Maximum Length: 60

  The project risk code of a risk impact.
• 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: integer (int64)
  The system-generated unique identifier for the pre-response impact threshold.
• riskScoreTypeId: 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.
• 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.

{
    "title":"ApiEntityRiskImpact",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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"
            ]
        },
        "projectRiskId":{
            "type":"integer",
            "description":"The system-generated unique identifier of the project risk.",
            "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"
            ]
        },
        "riskCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The project risk code of a risk impact.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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"
            ]
        },
        "riskScoreThresholdId":{
            "type":"integer",
            "description":"The system-generated unique identifier for the pre-response impact threshold.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "postRiskScoreThresholdId":{
            "type":"integer",
            "description":"The system-generated unique identifier for the post-response impact threshold.",
            "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"
            ]
        },
        "riskScoreTypeName":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string",
            "description":"The risk score type name of a risk impact.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityProjectRiskFinancial

Type: object

Title: ApiEntityProjectRiskFinancial

Show Source

• actualCostImpact: number (double)
  Minimum Value: 0

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

  The actual cost of implementing the response action. This field is in base currency and is calculated from actualResponseCostProject field based on the specified exchange rate.
• actualResponseCostProject: number (double)
  Minimum Value: 0

  The actual cost of implementing a response action. This value is based on the project currency.
• atCompletionTotalResponseCost: number (double)
  The total At Completion Response Cost of the risk.
• contingency: number (double)
  Minimum Value: 0

  The allowable risk cost should the risk occur.
• exposureImprovementCost: number (double)
  The difference between the Pre-Response Exposure and the Post-Response Exposure.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• postActualResponseCost: number (double)
  The total Post-Response Actual Response Cost of the risk.
• postAtCompletionTotalResponseCost: number (double)
  The total Post-Response At Completion Response Cost of the risk.
• postExposureCost: number (double)
  The mean post-response probability of the risk multiplied by the mean post-response cost impact of the risk. This field is in base currency and is calculated from postExposureCostProject field based on the specified exchange rate.
• postExposureCostProject: number (double)
  The mean post-response probability of the risk multiplied by the mean post-response cost impact of the risk. This value is based on the project currency.
• postQuantifiedCostThreshold: number (double)
  The estimated impact size that the risk will have on the project cost after implementing a response action.
• postRemainingTotalResponseCost: number (double)
  The total Post-Response Remaining Response Cost of the risk.
• postResponseExposureWorkspace1: number (double)
  The mean post-response probability of the risk multiplied by the mean post-response cost impact of the risk.
• postResponseExposureWorkspace2: number (double)
  The mean post-response probability of the risk multiplied by the mean post-response cost impact of the risk.
• postResponseExposureWorkspace3: number (double)
  The mean post-response probability of the risk multiplied by the mean post-response cost impact of the risk.
• preActualResponseCost: number (double)
  The total Pre-Response Actual Response Cost of the risk.
• preAtCompletionTotalResponseCost: number (double)
  The total Pre-Response At Completion Response Cost of the risk.
• preExposureCost: number (double)
  The mean pre-response probability of the risk multiplied by the mean pre-response cost impact of the risk. This field is in base currency and is calculated from preExposureCostProject field based on the specified exchange rate.
• preExposureCostProject: number (double)
  The mean pre-response probability of the risk multiplied by the mean pre-response cost impact of the risk. This value is based on the project currency.
• preQuantifiedCostThreshold: number (double)
  The estimated impact size that the risk will have on the project cost before implementing a response action.
• preRemainingTotalResponseCost: number (double)
  The total Pre-Response Remaining Response Cost of the risk.
• preResponseExposureWorkspace1: number (double)
  The mean pre-response probability of the risk multiplied by the mean pre-response cost impact of the risk.
• preResponseExposureWorkspace2: number (double)
  The mean pre-response probability of the risk multiplied by the mean pre-response cost impact of the risk.
• preResponseExposureWorkspace3: number (double)
  The mean pre-response probability of the risk multiplied by the mean pre-response cost impact of the risk.
• projectRiskId: integer (int64)
  The unique identifier of a project risk.
• remainingTotalResponseCost: number (double)
  The total Remaining Response Cost of the risk.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityProjectRiskFinancial",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectRiskId":{
            "type":"integer",
            "description":"The unique identifier of a project risk.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "preExposureCost":{
            "type":"number",
            "description":"The mean pre-response probability of the risk multiplied by the mean pre-response cost impact of the risk. This field is in base currency and is calculated from preExposureCostProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "preExposureCostProject":{
            "type":"number",
            "description":"The mean pre-response probability of the risk multiplied by the mean pre-response cost impact of the risk. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "postExposureCost":{
            "type":"number",
            "description":"The mean post-response probability of the risk multiplied by the mean post-response cost impact of the risk. This field is in base currency and is calculated from postExposureCostProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "postExposureCostProject":{
            "type":"number",
            "description":"The mean post-response probability of the risk multiplied by the mean post-response cost impact of the risk. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "preQuantifiedCostThreshold":{
            "type":"number",
            "description":"The estimated impact size that the risk will have on the project cost before implementing a response action.",
            "format":"double",
            "exampleSetFlag":false
        },
        "postQuantifiedCostThreshold":{
            "type":"number",
            "description":"The estimated impact size that the risk will have on the project cost after implementing a response action.",
            "format":"double",
            "exampleSetFlag":false
        },
        "actualResponseCost":{
            "minimum":"0",
            "type":"number",
            "description":"The actual cost of implementing the response action. This field is in base currency and is calculated from actualResponseCostProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "actualResponseCostProject":{
            "minimum":"0",
            "type":"number",
            "description":"The actual cost of implementing a response action. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "actualCostImpact":{
            "minimum":"0",
            "type":"number",
            "description":"The actual cost impact due to the risk occurring.",
            "format":"double",
            "exampleSetFlag":false
        },
        "contingency":{
            "minimum":"0",
            "type":"number",
            "description":"The allowable risk cost should the risk occur.",
            "format":"double",
            "exampleSetFlag":false
        },
        "remainingTotalResponseCost":{
            "type":"number",
            "description":"The total Remaining Response Cost of the risk.",
            "format":"double",
            "exampleSetFlag":false
        },
        "preRemainingTotalResponseCost":{
            "type":"number",
            "description":"The total Pre-Response Remaining Response Cost of the risk.",
            "format":"double",
            "exampleSetFlag":false
        },
        "postRemainingTotalResponseCost":{
            "type":"number",
            "description":"The total Post-Response Remaining Response Cost of the risk.",
            "format":"double",
            "exampleSetFlag":false
        },
        "preActualResponseCost":{
            "type":"number",
            "description":"The total Pre-Response Actual Response Cost of the risk.",
            "format":"double",
            "exampleSetFlag":false
        },
        "postActualResponseCost":{
            "type":"number",
            "description":"The total Post-Response Actual Response Cost of the risk.",
            "format":"double",
            "exampleSetFlag":false
        },
        "atCompletionTotalResponseCost":{
            "type":"number",
            "description":"The total At Completion Response Cost of the risk.",
            "format":"double",
            "exampleSetFlag":false
        },
        "preAtCompletionTotalResponseCost":{
            "type":"number",
            "description":"The total Pre-Response At Completion Response Cost of the risk.",
            "format":"double",
            "exampleSetFlag":false
        },
        "postAtCompletionTotalResponseCost":{
            "type":"number",
            "description":"The total Post-Response At Completion Response Cost of the risk.",
            "format":"double",
            "exampleSetFlag":false
        },
        "exposureImprovementCost":{
            "type":"number",
            "description":"The difference between the Pre-Response Exposure and the Post-Response Exposure.",
            "format":"double",
            "exampleSetFlag":false
        },
        "preResponseExposureWorkspace1":{
            "type":"number",
            "description":"The mean pre-response probability of the risk multiplied by the mean pre-response cost impact of the risk.",
            "format":"double",
            "exampleSetFlag":false
        },
        "preResponseExposureWorkspace2":{
            "type":"number",
            "description":"The mean pre-response probability of the risk multiplied by the mean pre-response cost impact of the risk.",
            "format":"double",
            "exampleSetFlag":false
        },
        "preResponseExposureWorkspace3":{
            "type":"number",
            "description":"The mean pre-response probability of the risk multiplied by the mean pre-response cost impact of the risk.",
            "format":"double",
            "exampleSetFlag":false
        },
        "postResponseExposureWorkspace1":{
            "type":"number",
            "description":"The mean post-response probability of the risk multiplied by the mean post-response cost impact of the risk.",
            "format":"double",
            "exampleSetFlag":false
        },
        "postResponseExposureWorkspace2":{
            "type":"number",
            "description":"The mean post-response probability of the risk multiplied by the mean post-response cost impact of the risk.",
            "format":"double",
            "exampleSetFlag":false
        },
        "postResponseExposureWorkspace3":{
            "type":"number",
            "description":"The mean post-response probability of the risk multiplied by the mean post-response cost impact of the risk.",
            "format":"double",
            "exampleSetFlag":false
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityRiskQuantifiedCostImpact

Type: object

Title: ApiEntityRiskQuantifiedCostImpact

Show Source

• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• 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.
• postResponseMaximumProject: number (double)
  The maximum cost of responding to a risk event. This value is based on the project currency.
• postResponseMaximumWorkspace1: number (double)
  The maximum cost of responding to a risk event.
• postResponseMaximumWorkspace2: number (double)
  The maximum cost of responding to a risk event.
• postResponseMaximumWorkspace3: number (double)
  The maximum cost of responding to a risk event.
• 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.
• postResponseMinimumProject: number (double)
  The minimum cost of responding to a risk event that has occurred. This value is based on the project currency.
• postResponseMinimumWorkspace1: number (double)
  The minimum cost of responding to a risk event that has occurred.
• postResponseMinimumWorkspace2: number (double)
  The minimum cost of responding to a risk event that has occurred.
• postResponseMinimumWorkspace3: number (double)
  The minimum cost of responding to a risk event that has occurred.
• 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.
• postResponseMostLikelyProject: number (double)
  The most likely cost of a risk event that has occurred. This value is based on the project currency.
• postResponseMostLikelyWorkspace1: number (double)
  The most likely cost of a risk event that has occurred.
• postResponseMostLikelyWorkspace2: number (double)
  The most likely cost of a risk event that has occurred.
• postResponseMostLikelyWorkspace3: number (double)
  The most likely probability that a risk event will occur.
• preResponseDistributionShape: 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.
• preResponseMaximumProject: number (double)
  The maximum cost of preparing for a risk event that has not occurred. This value is based on the project currency.
• preResponseMaximumWorkspace1: number (double)
  The maximum cost of preparing for a risk event that has not occurred.
• preResponseMaximumWorkspace2: number (double)
  The maximum cost of preparing for a risk event that has not occurred.
• preResponseMaximumWorkspace3: number (double)
  The maximum cost of preparing for a risk event that has not occurred.
• 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.
• preResponseMinimumProject: number (double)
  The minimum cost of preparing for a risk event that has not occurred. This value is based on the project currency.
• preResponseMinimumWorkspace1: number (double)
  The minimum cost of preparing for a risk event that has not occurred.
• preResponseMinimumWorkspace2: number (double)
  The minimum cost of preparing for a risk event that has not occurred.
• preResponseMinimumWorkspace3: number (double)
  The minimum cost of preparing for a risk event that has not occurred.
• 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.
• preResponseMostLikelyProject: number (double)
  The most likely cost of preparing for a risk event that has not occurred. This value is based on the project currency.
• preResponseMostLikelyWorkspace1: number (double)
  The most likely cost of preparing for a risk event that has not occurred.
• preResponseMostLikelyWorkspace2: number (double)
  The most likely cost of preparing for a risk event that has not occurred.
• preResponseMostLikelyWorkspace3: number (double)
  The most likely cost of preparing for a risk event that has not occurred.
• projectRiskId: integer (int64)
  The unique identifier of a project.
• quantifiedCostImpactId: integer (int64)
  The unique identifier of a cost impact.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityRiskQuantifiedCostImpact",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectRiskId":{
            "type":"integer",
            "description":"The unique identifier of a project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "quantifiedCostImpactId":{
            "type":"integer",
            "description":"The unique identifier of a cost impact.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "preResponseMinimumProject":{
            "type":"number",
            "description":"The minimum cost of preparing for a risk event that has not occurred. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "preResponseMinimumWorkspace1":{
            "type":"number",
            "description":"The minimum cost of preparing for a risk event that has not occurred.",
            "format":"double",
            "exampleSetFlag":false
        },
        "preResponseMinimumWorkspace2":{
            "type":"number",
            "description":"The minimum cost of preparing for a risk event that has not occurred.",
            "format":"double",
            "exampleSetFlag":false
        },
        "preResponseMinimumWorkspace3":{
            "type":"number",
            "description":"The minimum cost of preparing for a risk event that has not occurred.",
            "format":"double",
            "exampleSetFlag":false
        },
        "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
        },
        "preResponseMostLikelyProject":{
            "type":"number",
            "description":"The most likely cost of preparing for a risk event that has not occurred. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "preResponseMostLikelyWorkspace1":{
            "type":"number",
            "description":"The most likely cost of preparing for a risk event that has not occurred.",
            "format":"double",
            "exampleSetFlag":false
        },
        "preResponseMostLikelyWorkspace2":{
            "type":"number",
            "description":"The most likely cost of preparing for a risk event that has not occurred.",
            "format":"double",
            "exampleSetFlag":false
        },
        "preResponseMostLikelyWorkspace3":{
            "type":"number",
            "description":"The most likely cost of preparing for a risk event that has not occurred.",
            "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
        },
        "preResponseMaximumProject":{
            "type":"number",
            "description":"The maximum cost of preparing for a risk event that has not occurred. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "preResponseMaximumWorkspace1":{
            "type":"number",
            "description":"The maximum cost of preparing for a risk event that has not occurred.",
            "format":"double",
            "exampleSetFlag":false
        },
        "preResponseMaximumWorkspace2":{
            "type":"number",
            "description":"The maximum cost of preparing for a risk event that has not occurred.",
            "format":"double",
            "exampleSetFlag":false
        },
        "preResponseMaximumWorkspace3":{
            "type":"number",
            "description":"The maximum cost of preparing for a risk event that has not occurred.",
            "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
        },
        "postResponseMinimumProject":{
            "type":"number",
            "description":"The minimum cost of responding to a risk event that has occurred. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "postResponseMinimumWorkspace1":{
            "type":"number",
            "description":"The minimum cost of responding to a risk event that has occurred.",
            "format":"double",
            "exampleSetFlag":false
        },
        "postResponseMinimumWorkspace2":{
            "type":"number",
            "description":"The minimum cost of responding to a risk event that has occurred.",
            "format":"double",
            "exampleSetFlag":false
        },
        "postResponseMinimumWorkspace3":{
            "type":"number",
            "description":"The minimum cost of responding to a risk event that has occurred.",
            "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
        },
        "postResponseMostLikelyProject":{
            "type":"number",
            "description":"The most likely cost of a risk event that has occurred. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "postResponseMostLikelyWorkspace1":{
            "type":"number",
            "description":"The most likely cost of a risk event that has occurred.",
            "format":"double",
            "exampleSetFlag":false
        },
        "postResponseMostLikelyWorkspace2":{
            "type":"number",
            "description":"The most likely cost of a risk event that has occurred.",
            "format":"double",
            "exampleSetFlag":false
        },
        "postResponseMostLikelyWorkspace3":{
            "type":"number",
            "description":"The most likely probability that a risk event will occur.",
            "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
        },
        "postResponseMaximumProject":{
            "type":"number",
            "description":"The maximum cost of responding to a risk event. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "postResponseMaximumWorkspace1":{
            "type":"number",
            "description":"The maximum cost of responding to a risk event.",
            "format":"double",
            "exampleSetFlag":false
        },
        "postResponseMaximumWorkspace2":{
            "type":"number",
            "description":"The maximum cost of responding to a risk event.",
            "format":"double",
            "exampleSetFlag":false
        },
        "postResponseMaximumWorkspace3":{
            "type":"number",
            "description":"The maximum cost of responding to a risk event.",
            "format":"double",
            "exampleSetFlag":false
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityRiskQuantifiedOtherImpact

Type: object

Title: ApiEntityRiskQuantifiedOtherImpact

Show Source

• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• 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: integer (int64)
  The unique identifier of a project.
• quantifiedOtherImpactId: 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: string
  Allowed Values: [ "SINGLE_POINT", "TRIANGLE", "UNIFORM", "BETAPERT" ]

  The distribution that best models the three-point estimates for risk probabilities or risk schedule impacts.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityRiskQuantifiedOtherImpact",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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"
            ]
        },
        "mostLikely":{
            "type":"number",
            "description":"The most likely probability that a risk event will occur.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "preOrPostResponse":{
            "type":"string",
            "description":"Indicates whether a risk impact is measured pre or post response.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "PRE_RESPONSE",
                "POST_RESPONSE"
            ]
        },
        "quantifiedOtherImpactId":{
            "type":"integer",
            "description":"The unique identifier of a risk impact.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "scoreType":{
            "type":"string",
            "description":"The type of an impact score.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "PROBABILITY",
                "SCHEDULE",
                "RELATIVE_SCHEDULE",
                "COST",
                "RELATIVE_COST",
                "USER"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

204 Response

Successful operation with no content.

404 Response

Invalid input.

Back to Top