Jump to

• Request
• Response

Read RiskMatrixs

get

/riskMatrix

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

Type: array

Title: List<RiskMatrix>

Show Source

• Array of: object RiskMatrix
  Title: RiskMatrix

  RiskMatrix Entity

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

Nested Schema : RiskMatrix

Type: object

Title: RiskMatrix

RiskMatrix Entity

Show Source

• CreateDate: string (date-time)
  The date this risk matrix was created.
• CreateUser: string
  The name of the user that created the risk matrix.
• Description: string
  The description of the risk matrix.
• ImpactThresholdLevel: integer (int32)
  The number of levels for the impact thresholds assigned to the risk scoring matrix. This impact level with the probability level determines the size of the matrix.
• LastUpdateDate: string (date-time)
  The date this risk matrix was last updated.
• LastUpdateUser: string
  The name of the user that last updated the risk matrix.
• Name(required): string
  The name of the risk matrix.
• ObjectId: integer (int32)
  The unique ID generated by the system.
• ProbabilityThresholdLevel: integer (int32)
  The number of levels for the probability threshold assigned to the risk matrix. This probability level with the impact level determines the size of the matrix.
• RiskScoringMethod: string
  The calculation method used to determine the risk score. Valid values are 'Highest', 'Average of Impacts', 'Average of Individual Scores'.

{
    "title":"RiskMatrix",
    "required":[
        "Name"
    ],
    "type":"object",
    "properties":{
        "CreateDate":{
            "type":"string",
            "description":"The date this risk matrix was created.",
            "format":"date-time"
        },
        "CreateUser":{
            "type":"string",
            "description":"The name of the user that created the risk matrix."
        },
        "Description":{
            "type":"string",
            "description":"The description of the risk matrix."
        },
        "ImpactThresholdLevel":{
            "type":"integer",
            "description":"The number of levels for the impact thresholds assigned to the risk scoring matrix. This impact level with the probability level determines the size of the matrix.",
            "format":"int32"
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date this risk matrix was last updated.",
            "format":"date-time"
        },
        "LastUpdateUser":{
            "type":"string",
            "description":"The name of the user that last updated the risk matrix."
        },
        "Name":{
            "type":"string",
            "description":"The name of the risk matrix."
        },
        "ObjectId":{
            "type":"integer",
            "description":"The unique ID generated by the system.",
            "format":"int32"
        },
        "ProbabilityThresholdLevel":{
            "type":"integer",
            "description":"The number of levels for the probability threshold assigned to the risk matrix. This probability level with the impact level determines the size of the matrix.",
            "format":"int32"
        },
        "RiskScoringMethod":{
            "type":"string",
            "description":"The calculation method used to determine the risk score. Valid values are 'Highest', 'Average of Impacts', 'Average of Individual Scores'."
        }
    },
    "description":"RiskMatrix 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