Jump to

• Request
• Response

Update an Activity Risk

put

/api/restapi/activityRisk

Send a request to this endpoint to update an activity risk. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : ApiEntityActivityRiskInput

Type: object

Title: ApiEntityActivityRiskInput

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

• activityRiskId
• activityId,projectRiskId
• activityCode,projectCode,workspaceCode,projectRiskId
• activityId,projectCode,workspaceCode,riskCode
• activityCode,projectCode,workspaceCode,riskCode
• activityCode,projectId,projectRiskId
• activityId,projectId,riskCode
• activityCode,projectId,riskCode

Show Source

• activityCode: string
  Maximum Length: 60

  The user-specified identifier of the activity.
• activityId(required): integer (int64)
  The unique identifier of an activity assigned to a risk.
• activityRiskId: integer (int64)
  The unique identifier for the activity.The activity object can also be identified by its unique criteria.
• projectCode: string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectName: string
  Maximum Length: 255

  The name of the project.
• projectRiskId(required): integer (int64)
  The unique identifier for the project risk.The project risk object can also be identified by its unique criteria.
• quantifiedOtherImpacts: array quantifiedOtherImpacts
  Activity risk impacts associated with the activity.
• riskCode: string
  Maximum Length: 60

  The unique identifier for the risk.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.

{
    "title":"ApiEntityActivityRiskInput",
    "required":[
        "activityId",
        "projectRiskId"
    ],
    "type":"object",
    "properties":{
        "projectName":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "activityRiskId":{
            "type":"integer",
            "description":"The unique identifier for the activity.The activity object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectRiskId":{
            "type":"integer",
            "description":"The unique identifier for the project risk.The project risk object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "riskCode":{
            "maxLength":60,
            "type":"string",
            "description":"The unique identifier for the risk.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "quantifiedOtherImpacts":{
            "type":"array",
            "description":"Activity risk impacts associated with the activity.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityActivityRiskQuantifiedOtherImpactInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "activityId":{
            "type":"integer",
            "description":"The unique identifier of an activity assigned to a risk.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "activityCode":{
            "maxLength":60,
            "type":"string",
            "description":"The user-specified identifier of the activity.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":60,
            "minLength":0,
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a ActivityRisk object, a unique ActivityRisk object can be identified by the following combinations of the fields.<ul><li>activityRiskId</li><li>activityId,projectRiskId</li><li>activityCode,projectCode,workspaceCode,projectRiskId</li><li>activityId,projectCode,workspaceCode,riskCode</li><li>activityCode,projectCode,workspaceCode,riskCode</li><li>activityCode,projectId,projectRiskId</li><li>activityId,projectId,riskCode</li><li>activityCode,projectId,riskCode</li>",
    "exampleSetFlag":false
}

Nested Schema : quantifiedOtherImpacts

Type: array

Activity risk impacts associated with the activity.

Show Source

• Array of: object ApiEntityActivityRiskQuantifiedOtherImpactInput
  Title: ApiEntityActivityRiskQuantifiedOtherImpactInput

{
    "type":"array",
    "description":"Activity risk impacts associated with the activity.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityActivityRiskQuantifiedOtherImpactInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityActivityRiskQuantifiedOtherImpactInput

Type: object

Title: ApiEntityActivityRiskQuantifiedOtherImpactInput

Show Source

• activityRiskId: integer (int64)
  The unique identifier of the activity risk to which the risk is assigned.
• 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(required): string
  Allowed Values: [ "PRE_RESPONSE", "POST_RESPONSE" ]

  The type of risk analysis scenario run on the project.
  Pre-Response: A quantitative risk analysis that doesn't take into account the impact of defined risk response plans.
  Post-Response: A quantitative risk analysis that takes into account the impact of defined risk response plans.
  Pre- and Post-Response: A quantitative risk analysis that uses both scenarios.
• quantifiedOtherImpactId: integer (int64)
  The unique identifier for the Activity Risk Impact.
• scoreType(required): string
  Allowed Values: [ "PROBABILITY", "SCHEDULE", "RELATIVE_SCHEDULE", "COST", "RELATIVE_COST", "USER" ]

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

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

{
    "title":"ApiEntityActivityRiskQuantifiedOtherImpactInput",
    "required":[
        "preOrPostResponse",
        "scoreType",
        "shape"
    ],
    "type":"object",
    "properties":{
        "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.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "SINGLE_POINT",
                "TRIANGLE",
                "UNIFORM",
                "BETAPERT"
            ]
        },
        "activityRiskId":{
            "type":"integer",
            "description":"The unique identifier of the activity risk to which the risk is assigned.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "scoreType":{
            "type":"string",
            "description":"The name of the risk score type.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "PROBABILITY",
                "SCHEDULE",
                "RELATIVE_SCHEDULE",
                "COST",
                "RELATIVE_COST",
                "USER"
            ]
        },
        "mostLikely":{
            "type":"number",
            "description":"The most likely probability that a risk event will occur.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "quantifiedOtherImpactId":{
            "type":"integer",
            "description":"The unique identifier for the Activity Risk Impact.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "preOrPostResponse":{
            "type":"string",
            "description":"The type of risk analysis scenario run on the project. <br />Pre-Response: A quantitative risk analysis that doesn't take into account the impact of defined risk response plans. <br />Post-Response: A quantitative risk analysis that takes into account the impact of defined risk response plans. <br />Pre- and Post-Response: A quantitative risk analysis that uses both scenarios.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "PRE_RESPONSE",
                "POST_RESPONSE"
            ]
        }
    },
    "exampleSetFlag":false
}

Examples

Select an example Update an Activity Risk Using Activity Risk ID

Back to Top

Response

204 Response

Successful operation with no content.

400 Response

Invalid input for the Activity Risk service.

Back to Top