Jump to

• Request
• Response

Batch Create Activity Risks

post

/api/restapi/activityRisk/batch

Send a request to this endpoint to create one or more activity risks. An application object will be created for each JSON object provided in the request body.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : List<ApiEntityActivityRiskInput>

Type: array

Title: List<ApiEntityActivityRiskInput>

Show Source

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

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

Nested 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.
• 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.
• 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.
• 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.

{
    "title":"ApiEntityActivityRiskInput",
    "required":[
        "activityId",
        "projectRiskId"
    ],
    "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"
            ]
        },
        "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"
            ]
        },
        "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/ApiEntityActivityRiskQuantifiedOtherImpactInput",
                "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":"<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 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.
• 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(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.
• updateDate: string (date-time)
  Read Only: true

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

{
    "title":"ApiEntityActivityRiskQuantifiedOtherImpactInput",
    "required":[
        "preOrPostResponse",
        "scoreType",
        "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"
            ]
        },
        "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":"<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 Create Activity Risks

Back to Top

Response

Supported Media Types

• application/json

201 Response

The object was successfully created.

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
}

400 Response

Invalid input for the Activity Risk service.

Back to Top