Jump to

• Request
• Response

Create Risks

post

/risk

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

Request

Header Parameters

• Authorization(required):
  OAuth token

Supported Media Types

• application/json

Request Body - application/json ()

A list of risk objects.

Root Schema : List<Risk>

Type: array

Title: List<Risk>

Show Source

• Array of: object Risk
  Title: Risk

  Risk Entity

{
    "title":"List<Risk>",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Risk"
    }
}

Nested Schema : Risk

Type: object

Title: Risk

Risk Entity

Show Source

• Cause: string
  The description of the cause of the Risk.
• CostThresholdId: integer (int32)
• CreateDate: string (date-time)
  The date this risk was created.
• CreateUser: string
  The name of the user that created the risk.
• Description: string
  The description of the Risk.
• Effect: string
  The description of the risks effect on the project.
• Exposure: number (double)
  The calculated exposure value for the risk.
• ExposureFinishDate: string (date-time)
  The calculated date the exposure finishes for the risk.
• ExposureStartDate: string (date-time)
  The calculated date the exposure starts for the risk.
• Id(required): string
  The ID of the Risk. Must be unique within a project.
• IdentifiedByResourceId: string
  The short code of the resource that identified the risk.
• IdentifiedByResourceName: string
  The name of the resource that identified the risk.
• IdentifiedByResourceObjectId: integer (int32)
  The unique ID of the resource that identified the risk.
• IdentifiedDate: string (date-time)
  The date this risk was identified.
• ImpactThresholdValues: integer (int32)
• IsBaseline: boolean
  The boolean value indicating if this business object is related to a Project or Baseline.
• IsTemplate: boolean
  The boolean value indicating if this business object is related to a template Project.
• LastUpdateDate: string (date-time)
  The date this risk was last updated.
• LastUpdateUser: string
  The name of the user that last updated the risk.
• Name: string
  The name of the Risk. Does not need to be unique.
• Note: string
  The comments associated with the Risk.
• ObjectId: integer (int32)
  The unique ID generated by the system.
• ProbabilityThresholdId: integer (int32)
• ProjectId: string
  The short name of the associated project.
• ProjectName: string
  The name of the associated project.
• ProjectObjectId(required): integer (int32)
  The unique ID of the associated project.
• ResourceId: string
  The ID of the resource who owns the Risk. The owner of the Risk is responsible for resolving the Risk.
• ResourceName: string
  The name of the resource who owns the Risk. The owner of the Risk is responsible for resolving the Risk.
• ResourceObjectId: integer (int32)
  The unique ID of the associated resource.
• ResponseTotalCost: number (double)
  The total estimated cost for the risk. If the risk has an associated response plan, the cost is calculated from the risk response actions for the response plan. Not available if user does not have View Project Costs-Financial privilege.
• RiskCategoryName: string
  The name of the category to which the Risk is assigned. e.g. Weather, Health, Legal etc. A Risk can only be associated with a single category.
• RiskCategoryObjectId: integer (int32)
  The unique ID of the category to which the Risk is assigned. e.g. Weather, Health, Legal etc. A Risk can only be associated with a single category.
• ScheduleThresholdId: integer (int32)
• Score: integer (int32)
  The calculated score value of the impact values assigned to the risk.
• ScoreColor: string
  The color of the tolerance threshold for the score value.
• ScoreText: string
  The calculated score text value of the impact values assigned to the risk.
• Status: string
  The current status of the Risk. Valid values are 'Proposed', 'Open', 'Rejected', 'Managed', and 'Impacted'.
• Type: string
  The type of the risk. Valid values are 'Threat' and 'Opportunity'.

{
    "title":"Risk",
    "required":[
        "Id",
        "ProjectObjectId"
    ],
    "type":"object",
    "properties":{
        "Cause":{
            "type":"string",
            "description":"The description of the cause of the Risk."
        },
        "CostThresholdId":{
            "type":"integer",
            "format":"int32"
        },
        "CreateDate":{
            "type":"string",
            "description":"The date this risk was created.",
            "format":"date-time"
        },
        "CreateUser":{
            "type":"string",
            "description":"The name of the user that created the risk."
        },
        "Description":{
            "type":"string",
            "description":"The description of the Risk."
        },
        "Effect":{
            "type":"string",
            "description":"The description of the risks effect on the project."
        },
        "Exposure":{
            "type":"number",
            "description":"The calculated exposure value for the risk.",
            "format":"double"
        },
        "ExposureFinishDate":{
            "type":"string",
            "description":"The calculated date the exposure finishes for the risk.",
            "format":"date-time"
        },
        "ExposureStartDate":{
            "type":"string",
            "description":"The calculated date the exposure starts for the risk.",
            "format":"date-time"
        },
        "Id":{
            "type":"string",
            "description":"The ID of the Risk. Must be unique within a project."
        },
        "IdentifiedByResourceId":{
            "type":"string",
            "description":"The short code of the resource that identified the risk."
        },
        "IdentifiedByResourceName":{
            "type":"string",
            "description":"The name of the resource that identified the risk."
        },
        "IdentifiedByResourceObjectId":{
            "type":"integer",
            "description":"The unique ID of the resource that identified the risk.",
            "format":"int32"
        },
        "IdentifiedDate":{
            "type":"string",
            "description":"The date this risk was identified.",
            "format":"date-time"
        },
        "ImpactThresholdValues":{
            "type":"integer",
            "format":"int32"
        },
        "IsBaseline":{
            "type":"boolean",
            "description":"The boolean value indicating if this business object is related to a Project or Baseline."
        },
        "IsTemplate":{
            "type":"boolean",
            "description":"The boolean value indicating if this business object is related to a template Project."
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date this risk was last updated.",
            "format":"date-time"
        },
        "LastUpdateUser":{
            "type":"string",
            "description":"The name of the user that last updated the risk."
        },
        "Name":{
            "type":"string",
            "description":"The name of the Risk. Does not need to be unique."
        },
        "Note":{
            "type":"string",
            "description":"The comments associated with the Risk."
        },
        "ObjectId":{
            "type":"integer",
            "description":"The unique ID generated by the system.",
            "format":"int32"
        },
        "ProbabilityThresholdId":{
            "type":"integer",
            "format":"int32"
        },
        "ProjectId":{
            "type":"string",
            "description":"The short name of the associated project."
        },
        "ProjectName":{
            "type":"string",
            "description":"The name of the associated project."
        },
        "ProjectObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated project.",
            "format":"int32"
        },
        "ResourceId":{
            "type":"string",
            "description":"The ID of the resource who owns the Risk. The owner of the Risk is responsible for resolving the Risk."
        },
        "ResourceName":{
            "type":"string",
            "description":"The name of the resource who owns the Risk. The owner of the Risk is responsible for resolving the Risk."
        },
        "ResourceObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated resource.",
            "format":"int32"
        },
        "ResponseTotalCost":{
            "type":"number",
            "description":"The total estimated cost for the risk. If the risk has an associated response plan, the cost is calculated from the risk response actions for the response plan. Not available if user does not have View Project Costs-Financial privilege.",
            "format":"double"
        },
        "RiskCategoryName":{
            "type":"string",
            "description":"The name of the category to which the Risk is assigned. e.g. Weather, Health, Legal etc. A Risk can only be associated with a single category."
        },
        "RiskCategoryObjectId":{
            "type":"integer",
            "description":"The unique ID of the category to which the Risk is assigned. e.g. Weather, Health, Legal etc. A Risk can only be associated with a single category.",
            "format":"int32"
        },
        "ScheduleThresholdId":{
            "type":"integer",
            "format":"int32"
        },
        "Score":{
            "type":"integer",
            "description":"The calculated score value of the impact values assigned to the risk.",
            "format":"int32"
        },
        "ScoreColor":{
            "type":"string",
            "description":"The color of the tolerance threshold for the score value."
        },
        "ScoreText":{
            "type":"string",
            "description":"The calculated score text value of the impact values assigned to the risk."
        },
        "Status":{
            "type":"string",
            "description":"The current status of the Risk. Valid values are 'Proposed', 'Open', 'Rejected', 'Managed', and 'Impacted'."
        },
        "Type":{
            "type":"string",
            "description":"The type of the risk. Valid values are 'Threat' and 'Opportunity'."
        }
    },
    "description":"Risk Entity"
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Resource Created.

Body ()

Root Schema : String

Type: string

Title: String

400 Response

Bad Request.

401 Response

Unauthorized.

403 Response

Forbidden.

404 Response

Not Found.

405 Response

Invalid Input.

500 Response

Internal Server Error.

Back to Top