Jump to

• Request
• Response

Batch Update Program Risks

put

/api/restapi/programRisk/batch

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

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : List<ApiEntityProgramRiskInput>

Type: array

Title: List<ApiEntityProgramRiskInput>

Show Source

• Array of: object ApiEntityProgramRiskInput
  Title: ApiEntityProgramRiskInput

  This entity represents a ProgramRisk object, a unique ProgramRisk object can be identified by the following combinations of the fields.

  • programRiskId
  • riskCode,programId
  • riskCode,programCode,workspaceCode

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

Nested Schema : ApiEntityProgramRiskInput

Type: object

Title: ApiEntityProgramRiskInput

This entity represents a ProgramRisk object, a unique ProgramRisk object can be identified by the following combinations of the fields.

• programRiskId
• riskCode,programId
• riskCode,programCode,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.
• city: string
  Minimum Length: 0

  Maximum Length: 200

  The city name for a location.
• codeValuesProgramRisk: array codeValuesProgramRisk
  The list of code values for a program 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 program risk.
• 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.
• 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.
• 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)
  Read Only: true

  Deprecated. As of 23.10.
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• 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.
• postResponseMeanDelay: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The estimated average project delay duration before implementing a response action.
• postScore: integer (int32)
  Read Only: true

  Deprecated. As of 23.11.
  The post-response risk score calculated using the project risk matrix.
• preResponseMeanDelay: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The estimated average project delay duration before implementing a response action.
• probabilityImpactQuantified: boolean
  When selected, the quantified probability distribution is used to determine the probability that the risk occurs for each iteration.
• programCode: string
  Maximum Length: 60

  The unique identifier for a program set by the user who created the program.
• programId(required): integer (int64)
  The unique identifier for the program to which the risk was added.
• programRiskFinancial: programRiskFinancial
  The financial fields associated with a program risk.
• programRiskId: integer (int64)
  The system-generated identifier of the program risk.
• programRiskImpacts: array programRiskImpacts
  The impact of the program risk.
• programRiskQuantifiedCostImpact: programRiskQuantifiedCostImpact
  The impact this program risk will have on cost data.
• programRiskQuantifiedOtherImpacts: array programRiskQuantifiedOtherImpacts
  The impact this program risk will have on other data.
• programRiskStatus: 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)
  Read Only: true

  Deprecated. As of 23.11.
  The probability threshold that a risk will occur after implementing a response action.
• quantifiedPostResponseScheduleThreshold: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The estimated impact size that the risk will have on the project schedule after implementing a response action.
• quantifiedProbabilityThreshold: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The estimated probability that a risk will occur before implementing a response action.
• quantifiedScheduleThreshold: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The estimated impact size that the risk will have on the project schedule before implementing a response action.
• riskCode: string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for the risk.
• riskName(required): string
  Minimum Length: 0

  Maximum Length: 255

  The name of the risk.
• riskSourceType: string
  Read Only: true

  Allowed Values: [ "PROJECT", "PROGRAM" ]

  Deprecated. As of 23.11.
  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)
  Read Only: true

  Deprecated. As of 23.11.
  The pre-response risk score calculated using the project risk matrix.
• state: string
  Minimum Length: 0

  Maximum Length: 200

  The state, region, or province of a location.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.10.
  Date when the record was last updated.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

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

{
    "title":"ApiEntityProgramRiskInput",
    "required":[
        "programId",
        "riskName"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "programRiskFinancial":{
            "description":"The financial fields associated with a program risk.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityProgramRiskFinancialInput"
                }
            ]
        },
        "programRiskQuantifiedCostImpact":{
            "description":"The impact this program risk will have on cost data.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityProgramRiskQuantifiedCostImpactInput"
                }
            ]
        },
        "codeValuesProgramRisk":{
            "type":"array",
            "description":"The list of code values for a program risk. This entity can only be used to assign codeValues or create codeValues on the fly.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityCodeValueProgramRiskInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "configuredFields":{
            "type":"array",
            "description":"The list of configured fields for a program risk.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityProgramRiskConfiguredFieldValueInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "programId":{
            "type":"integer",
            "description":"The unique identifier for the program to which the risk was added.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a program set by the user who created the program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "programRiskId":{
            "type":"integer",
            "description":"The system-generated identifier of the program risk.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programRiskStatus":{
            "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"
            ]
        },
        "programRiskImpacts":{
            "type":"array",
            "description":"The impact of the program risk.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityProgramRiskImpactInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "programRiskQuantifiedOtherImpacts":{
            "type":"array",
            "description":"The impact this program risk will have on other data.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityProgramRiskQuantifiedOtherImpactInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "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":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The pre-response risk score calculated using the project risk matrix.",
            "format":"int32",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "postScore":{
            "type":"integer",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The post-response risk score calculated using the project risk matrix.",
            "format":"int32",
            "readOnly":true,
            "deprecated":true,
            "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":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The estimated impact size that the risk will have on the project schedule before implementing a response action.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "quantifiedProbabilityThreshold":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The estimated probability that a risk will occur before implementing a response action.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "quantifiedPostResponseScheduleThreshold":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The estimated impact size that the risk will have on the project schedule after implementing a response action.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "quantifiedPostResponseProbabilityThreshold":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The probability threshold that a risk will occur after implementing a response action.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "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":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The estimated average project delay duration before implementing a response action.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "postResponseMeanDelay":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The estimated average project delay duration before implementing a response action.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "riskSourceType":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The source type of the risk i.e. Project or Program.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "PROJECT",
                "PROGRAM"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a ProgramRisk object, a unique ProgramRisk object can be identified by the following combinations of the fields.<ul><li>programRiskId</li><li>riskCode,programId</li><li>riskCode,programCode,workspaceCode</li>",
    "exampleSetFlag":false
}

Nested Schema : codeValuesProgramRisk

Type: array

The list of code values for a program risk. This entity can only be used to assign codeValues or create codeValues on the fly.

Show Source

• Array of: object ApiEntityCodeValueProgramRiskInput
  Title: ApiEntityCodeValueProgramRiskInput

  This entity represents a CodeValueProgramRisk object, a unique CodeValueProgramRisk object can be identified by the following combinations of the fields.

  • codeValueProgramRiskId
  • 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 program risk. This entity can only be used to assign codeValues or create codeValues on the fly.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityCodeValueProgramRiskInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : configuredFields

Type: array

The list of configured fields for a program risk.

Show Source

• Array of: object ApiEntityProgramRiskConfiguredFieldValueInput
  Title: ApiEntityProgramRiskConfiguredFieldValueInput

  This entity represents a ProgramRiskConfiguredFieldValue object, a unique ProgramRiskConfiguredFieldValue object can be identified by the following combinations of the fields.

  • programRiskConfiguredFieldValueId
  • columnDefinitionId
  • columnName
  • columnLabel

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

Nested Schema : programRiskFinancial

The financial fields associated with a program risk.

Match All

Show Source

• object ApiEntityProgramRiskFinancialInput
  Title: ApiEntityProgramRiskFinancialInput

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

Nested Schema : programRiskImpacts

Type: array

The impact of the program risk.

Show Source

• Array of: object ApiEntityProgramRiskImpactInput
  Title: ApiEntityProgramRiskImpactInput

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

Nested Schema : programRiskQuantifiedCostImpact

The impact this program risk will have on cost data.

Match All

Show Source

• object ApiEntityProgramRiskQuantifiedCostImpactInput
  Title: ApiEntityProgramRiskQuantifiedCostImpactInput

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

Nested Schema : programRiskQuantifiedOtherImpacts

Type: array

The impact this program risk will have on other data.

Show Source

• Array of: object ApiEntityProgramRiskQuantifiedOtherImpactInput
  Title: ApiEntityProgramRiskQuantifiedOtherImpactInput

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

Nested Schema : ApiEntityCodeValueProgramRiskInput

Type: object

Title: ApiEntityCodeValueProgramRiskInput

This entity represents a CodeValueProgramRisk object, a unique CodeValueProgramRisk object can be identified by the following combinations of the fields.

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

  Maximum Length: 255

  Deprecated. As of 23.11.
  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.
• codeValueProgramRiskId: integer (int64)
  The unique identifier of a risk code value.
• link: string (url)
  Read Only: true

  Deprecated. As of 23.10.
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• parentId: integer (int64)
  The unique identifier of a parent code value.
• programRiskId: integer (int64)
  The system-generated identifier of the program risk.
• sequenceNumber: integer (int32)
  Deprecated. As of 23.11.
  The number that specifies the position of the code value item within the code type list.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.10.
  Date when the record was last updated.

{
    "title":"ApiEntityCodeValueProgramRiskInput",
    "required":[
        "codeTypeId",
        "codeValueCode"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "programRiskId":{
            "type":"integer",
            "description":"The system-generated identifier of the program risk.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeValueProgramRiskId":{
            "type":"integer",
            "description":"The unique identifier of a risk code value.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "sequenceNumber":{
            "type":"integer",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The number that specifies the position of the code value item within the code type list.",
            "format":"int32",
            "deprecated":true,
            "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"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "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":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The name of a code or value.",
            "deprecated":true,
            "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"
            ]
        }
    },
    "description":"This entity represents a CodeValueProgramRisk object, a unique CodeValueProgramRisk object can be identified by the following combinations of the fields.<ul><li>codeValueProgramRiskId</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 : ApiEntityProgramRiskConfiguredFieldValueInput

Type: object

Title: ApiEntityProgramRiskConfiguredFieldValueInput

This entity represents a ProgramRiskConfiguredFieldValue object, a unique ProgramRiskConfiguredFieldValue object can be identified by the following combinations of the fields.

• programRiskConfiguredFieldValueId
• 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.
• costValue: number
  Read Only: true

  Deprecated. As of 23.10.
  This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.
• costValueWorkspace1: number (double)
  Read Only: true

  Deprecated. As of 23.10.
  This holds values for Cost type configured fields in the workspace1 currency conversion.
• costValueWorkspace2: number (double)
  Read Only: true

  Deprecated. As of 23.10.
  This holds values for Cost type configured fields in the workspace2 currency conversion.
• costValueWorkspace3: number (double)
  Read Only: true

  Deprecated. As of 23.10.
  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
  Read Only: true

  Maximum Length: 4000

  Deprecated. As of 23.10.
  Provides the error message for why the formula calculation resulted in an error.
• hasException: boolean
  Read Only: true

  Deprecated. As of 23.10.
  Determines if formula calculation hit an error calculating a value for this field.
• link: string (url)
  Read Only: true

  Deprecated. As of 23.10.
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• 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.
• programRiskConfiguredFieldValueId: integer (int64)
  The unique identifier for the Program Risk Configured Field.
• programRiskId: integer (int64)
  The system-generated identifier of the program risk.
• textValue: string
  Maximum Length: 4000

  This holds values for Boolean, List and Text type configured fields.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.10.
  Date when the record was last updated.

{
    "title":"ApiEntityProgramRiskConfiguredFieldValueInput",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "programRiskId":{
            "type":"integer",
            "description":"The system-generated identifier of the program risk.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programRiskConfiguredFieldValueId":{
            "type":"integer",
            "description":"The unique identifier for the Program Risk Configured Field.",
            "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":"<b>Deprecated.</b> As of <i>23.10</i>.</br>This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "hasException":{
            "type":"boolean",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Determines if formula calculation hit an error calculating a value for this field.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "exceptionMessage":{
            "maxLength":"4000",
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Provides the error message for why the formula calculation resulted in an error.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "costValueWorkspace1":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>This holds values for Cost type configured fields in the workspace1 currency conversion.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "costValueWorkspace2":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>This holds values for Cost type configured fields in the workspace2 currency conversion.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "costValueWorkspace3":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>This holds values for Cost type configured fields in the workspace3 currency conversion.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "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"
            ]
        }
    },
    "description":"This entity represents a ProgramRiskConfiguredFieldValue object, a unique ProgramRiskConfiguredFieldValue object can be identified by the following combinations of the fields.<ul><li>programRiskConfiguredFieldValueId</li><li>columnDefinitionId</li><li>columnName</li><li>columnLabel</li>",
    "exampleSetFlag":false
}

Nested Schema : ApiEntityProgramRiskFinancialInput

Type: object

Title: ApiEntityProgramRiskFinancialInput

Show Source

• actualCostImpact: number (double)
  Minimum Value: 0

  The actual cost impact due to the risk occurring.
• actualResponseCost: number (double)
  Read Only: true

  Minimum Value: 0

  Deprecated. As of 23.11.
  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)
  Read Only: true

  Minimum Value: 0

  Deprecated. As of 23.11.
  The actual cost of implementing a response action. This value is based on the project currency.
• atCompletionTotalResponseCost: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The total At Completion Response Cost of the risk.
• contingency: number (double)
  Minimum Value: 0

  The allowable risk cost should the risk occur.
• link: string (url)
  Read Only: true

  Deprecated. As of 23.10.
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• postActualResponseCost: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The total Post-Response Actual Response Cost of the risk.
• postAtCompletionTotalResponseCost: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The total Post-Response At Completion Response Cost of the risk.
• postExposureCost: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  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)
  Read Only: true

  Deprecated. As of 23.11.
  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)
  Read Only: true

  Deprecated. As of 23.11.
  The estimated impact size that the risk will have on the project cost after implementing a response action.
• postRemainingTotalResponseCost: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The total Post-Response Remaining Response Cost of the risk.
• postResponseExposureWorkspace1: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The mean post-response probability of the risk multiplied by the mean post-response cost impact of the risk.
• postResponseExposureWorkspace2: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The mean post-response probability of the risk multiplied by the mean post-response cost impact of the risk.
• postResponseExposureWorkspace3: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The mean post-response probability of the risk multiplied by the mean post-response cost impact of the risk.
• preActualResponseCost: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The total Pre-Response Actual Response Cost of the risk.
• preAtCompletionTotalResponseCost: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The total Pre-Response At Completion Response Cost of the risk.
• preExposureCost: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  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)
  Read Only: true

  Deprecated. As of 23.11.
  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)
  Read Only: true

  Deprecated. As of 23.11.
  The estimated impact size that the risk will have on the project cost before implementing a response action.
• preRemainingTotalResponseCost: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The total Pre-Response Remaining Response Cost of the risk.
• preResponseExposureWorkspace1: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The mean pre-response probability of the risk multiplied by the mean pre-response cost impact of the risk.
• preResponseExposureWorkspace2: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The mean pre-response probability of the risk multiplied by the mean pre-response cost impact of the risk.
• preResponseExposureWorkspace3: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The mean pre-response probability of the risk multiplied by the mean pre-response cost impact of the risk.
• programRiskId(required): integer (int64)
  The system-generated identifier of the program risk.
• remainingTotalResponseCost: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The total Remaining Response Cost of the risk.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.10.
  Date when the record was last updated.

{
    "title":"ApiEntityProgramRiskFinancialInput",
    "required":[
        "programRiskId"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "programRiskId":{
            "type":"integer",
            "description":"The system-generated identifier of the program risk.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "preExposureCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>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",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "preExposureCostProject":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>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",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "postExposureCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>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",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "postExposureCostProject":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>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",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "preQuantifiedCostThreshold":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The estimated impact size that the risk will have on the project cost before implementing a response action.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "postQuantifiedCostThreshold":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The estimated impact size that the risk will have on the project cost after implementing a response action.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "actualResponseCost":{
            "minimum":"0",
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>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",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "actualResponseCostProject":{
            "minimum":"0",
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The actual cost of implementing a response action. This value is based on the project currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "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":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The total Remaining Response Cost of the risk.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "preRemainingTotalResponseCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The total Pre-Response Remaining Response Cost of the risk.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "postRemainingTotalResponseCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The total Post-Response Remaining Response Cost of the risk.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "preActualResponseCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The total Pre-Response Actual Response Cost of the risk.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "postActualResponseCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The total Post-Response Actual Response Cost of the risk.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "atCompletionTotalResponseCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The total At Completion Response Cost of the risk.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "preAtCompletionTotalResponseCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The total Pre-Response At Completion Response Cost of the risk.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "postAtCompletionTotalResponseCost":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The total Post-Response At Completion Response Cost of the risk.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "preResponseExposureWorkspace1":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The mean pre-response probability of the risk multiplied by the mean pre-response cost impact of the risk.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "preResponseExposureWorkspace2":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The mean pre-response probability of the risk multiplied by the mean pre-response cost impact of the risk.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "preResponseExposureWorkspace3":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The mean pre-response probability of the risk multiplied by the mean pre-response cost impact of the risk.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "postResponseExposureWorkspace1":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The mean post-response probability of the risk multiplied by the mean post-response cost impact of the risk.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "postResponseExposureWorkspace2":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The mean post-response probability of the risk multiplied by the mean post-response cost impact of the risk.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "postResponseExposureWorkspace3":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The mean post-response probability of the risk multiplied by the mean post-response cost impact of the risk.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityProgramRiskImpactInput

Type: object

Title: ApiEntityProgramRiskImpactInput

Show Source

• link: string (url)
  Read Only: true

  Deprecated. As of 23.10.
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• 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.
• programRiskId(required): integer (int64)
  The system-generated identifier of the program risk.
• riskCode: string
  Read Only: true

  Maximum Length: 60

  Deprecated. As of 23.11.
  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(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.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.10.
  Date when the record was last updated.
• workspaceCode: string
  Read Only: true

  Maximum Length: 60

  Deprecated. As of 23.11.
  The user-specified identifier of a workspace.

{
    "title":"ApiEntityProgramRiskImpactInput",
    "required":[
        "programRiskId",
        "riskScoreThresholdId",
        "riskScoreTypeId"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "programRiskId":{
            "type":"integer",
            "description":"The system-generated identifier of the program risk.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The user-specified identifier of a workspace.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "riskCode":{
            "maxLength":"60",
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The project risk code of a risk impact.",
            "readOnly":true,
            "deprecated":true,
            "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":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityProgramRiskQuantifiedCostImpactInput

Type: object

Title: ApiEntityProgramRiskQuantifiedCostImpactInput

Show Source

• link: string (url)
  Read Only: true

  Deprecated. As of 23.10.
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• 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)
  Read Only: true

  Deprecated. As of 23.11.
  The maximum cost of responding to a risk event. This value is based on the project currency.
• postResponseMaximumWorkspace1: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The maximum cost of responding to a risk event.
• postResponseMaximumWorkspace2: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The maximum cost of responding to a risk event.
• postResponseMaximumWorkspace3: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  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)
  Read Only: true

  Deprecated. As of 23.11.
  The minimum cost of responding to a risk event that has occurred. This value is based on the project currency.
• postResponseMinimumWorkspace1: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The minimum cost of responding to a risk event that has occurred.
• postResponseMinimumWorkspace2: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The minimum cost of responding to a risk event that has occurred.
• postResponseMinimumWorkspace3: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  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)
  Read Only: true

  Deprecated. As of 23.11.
  The most likely cost of a risk event that has occurred. This value is based on the project currency.
• postResponseMostLikelyWorkspace1: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The most likely cost of a risk event that has occurred.
• postResponseMostLikelyWorkspace2: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The most likely cost of a risk event that has occurred.
• postResponseMostLikelyWorkspace3: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The most likely probability that a risk event will occur.
• 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.
• preResponseMaximumProject: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The maximum cost of preparing for a risk event that has not occurred. This value is based on the project currency.
• preResponseMaximumWorkspace1: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The maximum cost of preparing for a risk event that has not occurred.
• preResponseMaximumWorkspace2: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The maximum cost of preparing for a risk event that has not occurred.
• preResponseMaximumWorkspace3: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  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)
  Read Only: true

  Deprecated. As of 23.11.
  The minimum cost of preparing for a risk event that has not occurred. This value is based on the project currency.
• preResponseMinimumWorkspace1: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The minimum cost of preparing for a risk event that has not occurred.
• preResponseMinimumWorkspace2: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The minimum cost of preparing for a risk event that has not occurred.
• preResponseMinimumWorkspace3: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  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)
  Read Only: true

  Deprecated. As of 23.11.
  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)
  Read Only: true

  Deprecated. As of 23.11.
  The most likely cost of preparing for a risk event that has not occurred.
• preResponseMostLikelyWorkspace2: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The most likely cost of preparing for a risk event that has not occurred.
• preResponseMostLikelyWorkspace3: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The most likely cost of preparing for a risk event that has not occurred.
• programRiskId(required): integer (int64)
  The system-generated identifier of the program risk.
• quantifiedCostImpactId: integer (int64)
  The unique identifier of a cost impact.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.10.
  Date when the record was last updated.

{
    "title":"ApiEntityProgramRiskQuantifiedCostImpactInput",
    "required":[
        "preResponseDistributionShape",
        "programRiskId"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "programRiskId":{
            "type":"integer",
            "description":"The system-generated identifier of the program risk.",
            "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":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The minimum cost of preparing for a risk event that has not occurred. This value is based on the project currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "preResponseMinimumWorkspace1":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The minimum cost of preparing for a risk event that has not occurred.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "preResponseMinimumWorkspace2":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The minimum cost of preparing for a risk event that has not occurred.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "preResponseMinimumWorkspace3":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The minimum cost of preparing for a risk event that has not occurred.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "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":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The most likely cost of preparing for a risk event that has not occurred. This value is based on the project currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "preResponseMostLikelyWorkspace1":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The most likely cost of preparing for a risk event that has not occurred.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "preResponseMostLikelyWorkspace2":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The most likely cost of preparing for a risk event that has not occurred.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "preResponseMostLikelyWorkspace3":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The most likely cost of preparing for a risk event that has not occurred.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "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":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The maximum cost of preparing for a risk event that has not occurred. This value is based on the project currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "preResponseMaximumWorkspace1":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The maximum cost of preparing for a risk event that has not occurred.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "preResponseMaximumWorkspace2":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The maximum cost of preparing for a risk event that has not occurred.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "preResponseMaximumWorkspace3":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The maximum cost of preparing for a risk event that has not occurred.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "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":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The minimum cost of responding to a risk event that has occurred. This value is based on the project currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "postResponseMinimumWorkspace1":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The minimum cost of responding to a risk event that has occurred.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "postResponseMinimumWorkspace2":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The minimum cost of responding to a risk event that has occurred.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "postResponseMinimumWorkspace3":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The minimum cost of responding to a risk event that has occurred.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "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":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The most likely cost of a risk event that has occurred. This value is based on the project currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "postResponseMostLikelyWorkspace1":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The most likely cost of a risk event that has occurred.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "postResponseMostLikelyWorkspace2":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The most likely cost of a risk event that has occurred.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "postResponseMostLikelyWorkspace3":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The most likely probability that a risk event will occur.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "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":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The maximum cost of responding to a risk event. This value is based on the project currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "postResponseMaximumWorkspace1":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The maximum cost of responding to a risk event.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "postResponseMaximumWorkspace2":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The maximum cost of responding to a risk event.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "postResponseMaximumWorkspace3":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The maximum cost of responding to a risk event.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityProgramRiskQuantifiedOtherImpactInput

Type: object

Title: ApiEntityProgramRiskQuantifiedOtherImpactInput

Show Source

• link: string (url)
  Read Only: true

  Deprecated. As of 23.10.
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• 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.
• programRiskId(required): integer (int64)
  The system-generated identifier of the program risk.
• 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.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.10.
  Date when the record was last updated.

{
    "title":"ApiEntityProgramRiskQuantifiedOtherImpactInput",
    "required":[
        "programRiskId",
        "quantifiedOtherImpactId",
        "shape"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "programRiskId":{
            "type":"integer",
            "description":"The system-generated identifier of the program risk.",
            "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":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Examples

Select an example Batch Update Program Risks Using Program Risk 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