Jump to

• Request
• Response

Read RiskResponseActions

get

/riskResponseAction

Reads RiskResponseAction objects from the database.

Request

Query Parameters

• Fields(required): string
  Fields to load

  Example:

  Name,ObjectId

• Filter(required): 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(required): string
  OrderBy condition

  Example:

  ObjectId desc

Header Parameters

• Authorization(required):
  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<RiskResponseAction>

Type: array

Title: List<RiskResponseAction>

Show Source

• Array of: object RiskResponseAction
  Title: RiskResponseAction

  RiskResponseAction Entity

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

Nested Schema : RiskResponseAction

Type: object

Title: RiskResponseAction

RiskResponseAction Entity

Show Source

• ActivityId: string
  The id of an activity impacted by the Risk.
• ActivityName: string
  The name of an activity impacted by the Risk. The activity name does not have to be unique.
• ActivityObjectId: integer (int32)
  The unique ID of the associated activity.
• ActualCost: number (double)
  The actual cost.
• CreateDate: string (date-time)
  The date this risk response action impact was created.
• CreateUser: string
  The name of the user that created the risk response action impact.
• 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: string
  The unique Id of the risk response action.
• 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 action impact was last updated.
• LastUpdateUser: string
  The name of the user that last updated the risk response action impact.
• Name: string
  The name of the risk response action.
• ObjectId: integer (int32)
  The unique ID of the associated risk.
• 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.
• ResourceId: string
  The ID of the resource who owns the risk response action. The owner of the risk response action is responsible for resolving the risk response action.
• ResourceName: string
  The name of the resource who owns the risk response action. The owner of the risk response action is responsible for resolving the risk response action.
• ResourceObjectId: integer (int32)
  The unique ID of the associated resource.
• RiskId: string
  The ID of the Risk. Must be unique within a project.
• RiskObjectId: integer (int32)
  The unique ID of the associated risk.
• RiskResponsePlanId: string
  The ID of the risk response plan. This must be unique within the project.
• RiskResponsePlanName: string
  The name of the risk response plan. This does not need to be unique within the project.
• RiskResponsePlanObjectId: integer (int32)
  The unique ID of the associated risk response plan.
• Score: integer (int32)
  The risk score from the numeric PID after the response action has been completed.
• ScoreColor: string
  The color of the tolerance threshold for the score value.
• ScoreText: string
  The risk score from the alphanumeric PID after the response action has been completed.
• 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.
• Status: string
  The status of the risk response action. Valid values are 'Proposed', 'Sanctioned', 'Rejected', 'InProgress', and 'Complete'.

{
    "title":"RiskResponseAction",
    "type":"object",
    "properties":{
        "ActivityId":{
            "type":"string",
            "description":"The id of an activity impacted by the Risk."
        },
        "ActivityName":{
            "type":"string",
            "description":"The name of an activity impacted by the Risk. The activity name does not have to be unique."
        },
        "ActivityObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated activity.",
            "format":"int32"
        },
        "ActualCost":{
            "type":"number",
            "description":"The actual cost.",
            "format":"double"
        },
        "CreateDate":{
            "type":"string",
            "description":"The date this risk response action impact was created.",
            "format":"date-time"
        },
        "CreateUser":{
            "type":"string",
            "description":"The name of the user that created the risk response action impact."
        },
        "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 unique Id of the risk response action."
        },
        "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 action impact was last updated.",
            "format":"date-time"
        },
        "LastUpdateUser":{
            "type":"string",
            "description":"The name of the user that last updated the risk response action impact."
        },
        "Name":{
            "type":"string",
            "description":"The name of the risk response action."
        },
        "ObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated risk.",
            "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"
        },
        "ResourceId":{
            "type":"string",
            "description":"The ID of the resource who owns the risk response action. The owner of the risk response action is responsible for resolving the risk response action."
        },
        "ResourceName":{
            "type":"string",
            "description":"The name of the resource who owns the risk response action. The owner of the risk response action is responsible for resolving the risk response action."
        },
        "ResourceObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated resource.",
            "format":"int32"
        },
        "RiskId":{
            "type":"string",
            "description":"The ID of the Risk. Must be unique within a project."
        },
        "RiskObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated risk.",
            "format":"int32"
        },
        "RiskResponsePlanId":{
            "type":"string",
            "description":"The ID of the risk response plan. This must be unique within the project."
        },
        "RiskResponsePlanName":{
            "type":"string",
            "description":"The name of the risk response plan. This does not need to be unique within the project."
        },
        "RiskResponsePlanObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated risk response plan.",
            "format":"int32"
        },
        "Score":{
            "type":"integer",
            "description":"The risk score from the numeric PID after the response action has been completed.",
            "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 the response action has been completed."
        },
        "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"
        },
        "Status":{
            "type":"string",
            "description":"The status of the risk response action. Valid values are 'Proposed', 'Sanctioned', 'Rejected', 'InProgress', and 'Complete'."
        }
    },
    "description":"RiskResponseAction 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