Jump to

• Request
• Response

View all Activity Risks by Project Risk ID

get

/api/restapi/activityRisk/projectRisk/{projectRiskId}

This endpoint returns activity risks that meet the following requirements:

• The object is associated with a project risk with an ID value that matches the value of the {projectRiskId} path parameter.

Request

Path Parameters

• projectRiskId(required): integer(int64)
  The system-generated identifier of a project risk.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : List<ApiEntityActivityRisk>

Type: array

Title: List<ApiEntityActivityRisk>

Show Source

• Array of: object ApiEntityActivityRisk
  Title: ApiEntityActivityRisk

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

Nested Schema : ApiEntityActivityRisk

Type: object

Title: ApiEntityActivityRisk

Show Source

• activityCode: string
  Maximum Length: 60

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

  Maximum Length: 60

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

  The name of the project.
• projectRiskId: 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.
• updateDate: string (date-time)
  Date when the record was last updated.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.

{
    "title":"ApiEntityActivityRisk",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "activityCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified identifier of the activity.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "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"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "activityId":{
            "type":"integer",
            "description":"The unique identifier of an activity assigned to a risk.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "quantifiedOtherImpacts":{
            "type":"array",
            "description":"Activity risk impacts associated with the activity.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityActivityRiskQuantifiedOtherImpact",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "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"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : quantifiedOtherImpacts

Type: array

Activity risk impacts associated with the activity.

Show Source

• Array of: object ApiEntityActivityRiskQuantifiedOtherImpact
  Title: ApiEntityActivityRiskQuantifiedOtherImpact

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

Nested Schema : ApiEntityActivityRiskQuantifiedOtherImpact

Type: object

Title: ApiEntityActivityRiskQuantifiedOtherImpact

Show Source

• activityRiskId: integer (int64)
  The unique identifier of the activity risk to which the risk is assigned.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• maximum: number (double)
  The maximum probability that a risk event will occur.
• minimum: number (double)
  The minimum probability that a risk event will occur.
• mostLikely: number (double)
  The most likely probability that a risk event will occur.
• preOrPostResponse: string
  Allowed Values: [ "PRE_RESPONSE", "POST_RESPONSE" ]

  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: string
  Allowed Values: [ "PROBABILITY", "SCHEDULE", "RELATIVE_SCHEDULE", "COST", "RELATIVE_COST", "USER" ]

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

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

{
    "title":"ApiEntityActivityRiskQuantifiedOtherImpact",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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"
            ]
        },
        "mostLikely":{
            "type":"number",
            "description":"The most likely probability that a risk event will occur.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "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"
            ]
        },
        "quantifiedOtherImpactId":{
            "type":"integer",
            "description":"The unique identifier for the Activity Risk Impact.",
            "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"
            ]
        },
        "activityRiskId":{
            "type":"integer",
            "description":"The unique identifier of the activity risk to which the risk is assigned.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

204 Response

Successful operation with no content.

404 Response

The requested activity risk does not exist, or you do not have access to it.

Back to Top