Jump to

• Request
• Response

Read RiskMatrixScores

get

/riskMatrixScore

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

Type: array

Title: List<RiskMatrixScore>

Show Source

• Array of: object RiskMatrixScore
  Title: RiskMatrixScore

  RiskMatrixScore Entity

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

Nested Schema : RiskMatrixScore

Type: object

Title: RiskMatrixScore

RiskMatrixScore Entity

Show Source

• CreateDate: string (date-time)
  The date this risk matrix score was created.
• CreateUser: string
  The name of the user that created the risk matrix score.
• LastUpdateDate: string (date-time)
  The date this risk matrix score was last updated.
• LastUpdateUser: string
  The name of the user that last updated the risk matrix score.
• ObjectId: integer (int32)
  The unique ID generated by the system.
• ProbabilityThresholdLevel(required): integer (int32)
  The level number of the probability threshold. Valid numbers are 1-9.
• RiskMatrixName: string
  The name of the Risk Matrix.
• RiskMatrixObjectId(required): integer (int32)
  The unique ID of the associated Risk Matrix.
• Severity1: integer (int32)
  The first severity level of the Risk Matrix Score.
• Severity1Label: string
  The label for the first severity level.
• Severity2: integer (int32)
  The second severity level of the Risk Matrix Score.
• Severity2Label: string
  The label for the second severity level.
• Severity3: integer (int32)
  The third severity level of the Risk Matrix Score.
• Severity3Label: string
  The label for the third severity level.
• Severity4: integer (int32)
  The fourth severity level of the Risk Matrix Score.
• Severity4Label: string
  The label for the forth severity level.
• Severity5: integer (int32)
  The fifth severity level of the Risk Matrix Score.
• Severity5Label: string
  The label for the fith severity level.
• Severity6: integer (int32)
  The sixth severity level of the Risk Matrix Score.
• Severity6Label: string
  The sixth for the first severity level.
• Severity7: integer (int32)
  The seventh severity level of the Risk Matrix Score.
• Severity7Label: string
  The label for the seventh severity level.
• Severity8: integer (int32)
  The eighth severity level of the Risk Matrix Score.
• Severity8Label: string
  The label for the eighth severity level.
• Severity9: integer (int32)
  The ninth severity level of the Risk Matrix Score.
• Severity9Label: string
  The label for the ninth severity level.

{
    "title":"RiskMatrixScore",
    "required":[
        "ProbabilityThresholdLevel",
        "RiskMatrixObjectId"
    ],
    "type":"object",
    "properties":{
        "CreateDate":{
            "type":"string",
            "description":"The date this risk matrix score was created.",
            "format":"date-time"
        },
        "CreateUser":{
            "type":"string",
            "description":"The name of the user that created the risk matrix score."
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date this risk matrix score was last updated.",
            "format":"date-time"
        },
        "LastUpdateUser":{
            "type":"string",
            "description":"The name of the user that last updated the risk matrix score."
        },
        "ObjectId":{
            "type":"integer",
            "description":"The unique ID generated by the system.",
            "format":"int32"
        },
        "ProbabilityThresholdLevel":{
            "type":"integer",
            "description":"The level number of the probability threshold. Valid numbers are 1-9.",
            "format":"int32"
        },
        "RiskMatrixName":{
            "type":"string",
            "description":"The name of the Risk Matrix."
        },
        "RiskMatrixObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated Risk Matrix.",
            "format":"int32"
        },
        "Severity1":{
            "type":"integer",
            "description":"The first severity level of the Risk Matrix Score.",
            "format":"int32"
        },
        "Severity1Label":{
            "type":"string",
            "description":"The label for the first severity level."
        },
        "Severity2":{
            "type":"integer",
            "description":"The second severity level of the Risk Matrix Score.",
            "format":"int32"
        },
        "Severity2Label":{
            "type":"string",
            "description":"The label for the second severity level."
        },
        "Severity3":{
            "type":"integer",
            "description":"The third severity level of the Risk Matrix Score.",
            "format":"int32"
        },
        "Severity3Label":{
            "type":"string",
            "description":"The label for the third severity level."
        },
        "Severity4":{
            "type":"integer",
            "description":"The fourth severity level of the Risk Matrix Score.",
            "format":"int32"
        },
        "Severity4Label":{
            "type":"string",
            "description":"The label for the forth severity level."
        },
        "Severity5":{
            "type":"integer",
            "description":"The fifth severity level of the Risk Matrix Score.",
            "format":"int32"
        },
        "Severity5Label":{
            "type":"string",
            "description":"The label for the fith severity level."
        },
        "Severity6":{
            "type":"integer",
            "description":"The sixth severity level of the Risk Matrix Score.",
            "format":"int32"
        },
        "Severity6Label":{
            "type":"string",
            "description":"The sixth for the first severity level."
        },
        "Severity7":{
            "type":"integer",
            "description":"The seventh severity level of the Risk Matrix Score.",
            "format":"int32"
        },
        "Severity7Label":{
            "type":"string",
            "description":"The label for the seventh severity level."
        },
        "Severity8":{
            "type":"integer",
            "description":"The eighth severity level of the Risk Matrix Score.",
            "format":"int32"
        },
        "Severity8Label":{
            "type":"string",
            "description":"The label for the eighth severity level."
        },
        "Severity9":{
            "type":"integer",
            "description":"The ninth severity level of the Risk Matrix Score.",
            "format":"int32"
        },
        "Severity9Label":{
            "type":"string",
            "description":"The label for the ninth severity level."
        }
    },
    "description":"RiskMatrixScore 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