Jump to

• Request
• Response

Read RiskResponseActionImpacts

get

/riskResponseActionImpact

Reads RiskResponseActionImpact 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<RiskResponseActionImpact>

Type: array

Title: List<RiskResponseActionImpact>

Show Source

• Array of: object RiskResponseActionImpact
  Title: RiskResponseActionImpact

  RiskResponseActionImpact Entity

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

Nested Schema : RiskResponseActionImpact

Type: object

Title: RiskResponseActionImpact

RiskResponseActionImpact Entity

Show Source

• CreateDate: string (date-time)
  The date this risk response action was created.
• CreateUser: string
  The name of the user that created 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 was last updated.
• LastUpdateUser: string
  The name of the user that last updated the risk response action.
• 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.
• RiskId: string
  The unique identifier of the risk or risks assigned to this activity.
• RiskObjectId: integer (int32)
  The unique ID generated by the system.
• RiskResponseActionId: string
  The ID of the RiskResponseAction.
• RiskResponseActionName: string
  The name of the RiskResponseAction.
• RiskResponseActionObjectId(required): integer (int32)
  The unique ID of the RiskResponseAction.
• RiskThresholdLevelCode: string
  The 10 character short name for the threshold level. Must be unique.
• RiskThresholdLevelName: string
  The 40 character name for the threshold level. Does not need to be unique.
• RiskThresholdLevelObjectId(required): integer (int32)
  The unique ID of the associated Risk Threshold Level.
• RiskThresholdName: string
  The name of the associated risk score type.
• RiskThresholdObjectId: integer (int32)
  The unique ID of the associated Risk Threshold.

{
    "title":"RiskResponseActionImpact",
    "required":[
        "RiskResponseActionObjectId",
        "RiskThresholdLevelObjectId"
    ],
    "type":"object",
    "properties":{
        "CreateDate":{
            "type":"string",
            "description":"The date this risk response action was created.",
            "format":"date-time"
        },
        "CreateUser":{
            "type":"string",
            "description":"The name of the user that created 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 was last updated.",
            "format":"date-time"
        },
        "LastUpdateUser":{
            "type":"string",
            "description":"The name of the user that last updated the risk response action."
        },
        "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"
        },
        "RiskId":{
            "type":"string",
            "description":"The unique identifier of the risk or risks assigned to this activity."
        },
        "RiskObjectId":{
            "type":"integer",
            "description":"The unique ID generated by the system.",
            "format":"int32"
        },
        "RiskResponseActionId":{
            "type":"string",
            "description":"The ID of the RiskResponseAction."
        },
        "RiskResponseActionName":{
            "type":"string",
            "description":"The name of the RiskResponseAction."
        },
        "RiskResponseActionObjectId":{
            "type":"integer",
            "description":"The unique ID of the RiskResponseAction.",
            "format":"int32"
        },
        "RiskThresholdLevelCode":{
            "type":"string",
            "description":"The 10 character short name for the threshold level. Must be unique."
        },
        "RiskThresholdLevelName":{
            "type":"string",
            "description":"The 40 character name for the threshold level. Does not need to be unique."
        },
        "RiskThresholdLevelObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated Risk Threshold Level.",
            "format":"int32"
        },
        "RiskThresholdName":{
            "type":"string",
            "description":"The name of the associated risk score type."
        },
        "RiskThresholdObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated Risk Threshold.",
            "format":"int32"
        }
    },
    "description":"RiskResponseActionImpact 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