Jump to

• Request
• Response

Read RiskResponsePlans

get

/riskResponsePlan

Reads RiskResponsePlan objects from the database.

Request

Query Parameters

• Fields(required): string
  Fields to load

  Example:

  Name,ObjectId

• Filter: string
  Supported Filter Operators - :gt:, :lt:, :eq:, :gte:, :lte:, :and:, :or:

  Example:

  ObjectId IN(1,2) :and: CreateDate:gte:'2021-04-20' :and: LastUpdateDate:lt:'2022-04-20' :and: Name :like: 'abc%'

• OrderBy: string
  OrderBy condition

  Example:

  ObjectId desc

Header Parameters

• Authorization:
  OAuth token

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : List<RiskResponsePlan>

Type: array

Title: List<RiskResponsePlan>

Show Source

• Array of: object RiskResponsePlan
  Title: RiskResponsePlan

  RiskResponsePlan Entity

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

Nested Schema : RiskResponsePlan

Type: object

Title: RiskResponsePlan

RiskResponsePlan Entity

Show Source

• ActualCost: number (double)
  The actual cost.
• CreateDate: string (date-time)
  The date this risk response plan was created.
• CreateUser: string
  The name of the user that created the risk response plan.
• FinishDate: string (date-time)
  The finish date of the risk response action. If an activity is assigned, the risk response action uses the activity finish date.
• Id(required): string
  The ID of the risk response plan. This must be unique within the assigned risk.
• IsActive: boolean
  The indication of whether the response plan is currently active for the associated risk. Only one response plan can be active at a given time for a risk.
• 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 response plan was last updated.
• LastUpdateUser: string
  The name of the user that last updated the risk response plan.
• Name: string
  The name of the risk response plan.
• ObjectId: integer (int32)
  The unique ID generated by the system.
• PlannedCost: number (double)
  The planned cost.
• PlannedFinishDate: string (date-time)
  The planned finish date.
• PlannedStartDate: string (date-time)
  The planned start date.
• ProjectId: string
  The short name of the associated project.
• ProjectName: string
  The name of the associated project.
• ProjectObjectId: integer (int32)
  The unique ID of the associated project.
• RemainingCost: number (double)
  The remaining cost associated with the risk response action.
• ResponseType: string
  The risk response plan type. If the risk is a threat, the valid types are 'Avoid', 'Transfer', 'Reduce', and 'Accept'. If the risk is a opportunity, the valid types are 'Exploit', 'Facilitate', 'Enhance', and 'Reject'.
• RiskId: string
  The ID of the risk.
• RiskName: string
  The name of the risk.
• RiskObjectId(required): integer (int32)
  The unique ID of the associated risk.
• Score: integer (int32)
  The risk score from the numeric PID after all response actions of the response plan have been completed. The post response plan score is set from the response action with the latest finish date and the lowest score when more than one response action has the same date.
• ScoreColor: string
  The color of the tolerance threshold for the score value.
• ScoreText: string
  The risk score from the alphanumeric PID after all response actions of the response plan have been completed. The post response plan score is set from the response action with the latest finish date and the lowest score when more than one response action has the same date.
• StartDate: string (date-time)
  The start date of the risk response action. If an activity is assigned, the risk response action uses the activity start date.

{
    "title":"RiskResponsePlan",
    "required":[
        "Id",
        "RiskObjectId"
    ],
    "type":"object",
    "properties":{
        "ActualCost":{
            "type":"number",
            "description":"The actual cost.",
            "format":"double"
        },
        "CreateDate":{
            "type":"string",
            "description":"The date this risk response plan was created.",
            "format":"date-time"
        },
        "CreateUser":{
            "type":"string",
            "description":"The name of the user that created the risk response plan."
        },
        "FinishDate":{
            "type":"string",
            "description":"The finish date of the risk response action. If an activity is assigned, the risk response action uses the activity finish date.",
            "format":"date-time"
        },
        "Id":{
            "type":"string",
            "description":"The ID of the risk response plan. This must be unique within the assigned risk."
        },
        "IsActive":{
            "type":"boolean",
            "description":"The indication of whether the response plan is currently active for the associated risk. Only one response plan can be active at a given time for a risk."
        },
        "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 response plan was last updated.",
            "format":"date-time"
        },
        "LastUpdateUser":{
            "type":"string",
            "description":"The name of the user that last updated the risk response plan."
        },
        "Name":{
            "type":"string",
            "description":"The name of the risk response plan."
        },
        "ObjectId":{
            "type":"integer",
            "description":"The unique ID generated by the system.",
            "format":"int32"
        },
        "PlannedCost":{
            "type":"number",
            "description":"The planned cost.",
            "format":"double"
        },
        "PlannedFinishDate":{
            "type":"string",
            "description":"The planned finish date.",
            "format":"date-time"
        },
        "PlannedStartDate":{
            "type":"string",
            "description":"The planned start date.",
            "format":"date-time"
        },
        "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"
        },
        "RemainingCost":{
            "type":"number",
            "description":"The remaining cost associated with the risk response action.",
            "format":"double"
        },
        "ResponseType":{
            "type":"string",
            "description":"The risk response plan type. If the risk is a threat, the valid types are 'Avoid', 'Transfer', 'Reduce', and 'Accept'. If the risk is a opportunity, the valid types are 'Exploit', 'Facilitate', 'Enhance', and 'Reject'."
        },
        "RiskId":{
            "type":"string",
            "description":"The ID of the risk."
        },
        "RiskName":{
            "type":"string",
            "description":"The name of the risk."
        },
        "RiskObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated risk.",
            "format":"int32"
        },
        "Score":{
            "type":"integer",
            "description":"The risk score from the numeric PID after all response actions of the response plan have been completed. The post response plan score is set from the response action with the latest finish date and the lowest score when more than one response action has the same date.",
            "format":"int32"
        },
        "ScoreColor":{
            "type":"string",
            "description":"The color of the tolerance threshold for the score value."
        },
        "ScoreText":{
            "type":"string",
            "description":"The risk score from the alphanumeric PID after all response actions of the response plan have been completed. The post response plan score is set from the response action with the latest finish date and the lowest score when more than one response action has the same date."
        },
        "StartDate":{
            "type":"string",
            "description":"The start date of the risk response action. If an activity is assigned, the risk response action uses the activity start date.",
            "format":"date-time"
        }
    },
    "description":"RiskResponsePlan Entity"
}

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