Jump to

• Request
• Response

Read RiskThresholdLevels

get

/riskThresholdLevel

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

Type: array

Title: List<RiskThresholdLevel>

Show Source

• Array of: object RiskThresholdLevel
  Title: RiskThresholdLevel

  RiskThresholdLevel Entity

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

Nested Schema : RiskThresholdLevel

Type: object

Title: RiskThresholdLevel

RiskThresholdLevel Entity

Show Source

• Code(required): string
  The 10 character code for the threshold level. Must be unique.
• Color: string
  The Hex representation for the color e.g. 0xFFFFFF.
• CostRange: number (double)
  The cost range of the threshold level.
• CreateDate: string (date-time)
  The date this threshold level was created.
• CreateUser: string
  The name of the user that created the threshold level.
• LastUpdateDate: string (date-time)
  The date this threshold level was last updated.
• LastUpdateUser: string
  The name of the user that last updated the threshold level.
• Level: integer (int32)
  The valid values are between 0 and 9. Defines a level for the Risk Threshold.
• Name: string
  The 40 character name for the threshold level. Does not need to be unique.
• ObjectId: integer (int32)
  The unique ID generated by the system.
• ProbabilityRange: number (double)
  The probability range of the threshold level.
• Range: string
  The user defined range.
• RiskThresholdName: string
  The name of the associated risk score type.
• RiskThresholdObjectId(required): integer (int32)
  The unique ID of the associated Risk Threshold.
• ScheduleRange: number (double)
  The schedule range of the threshold level.
• ThresholdType: string
  The type of Risk Threshold. Valid types are 'Probability', 'Tolerance', 'Schedule', 'Cost', 'Relative Schedule', 'Relative Cost' and 'User Defined'.
• ToleranceRange: integer (int32)
  The tolerance range of the threshold level.

{
    "title":"RiskThresholdLevel",
    "required":[
        "Code",
        "RiskThresholdObjectId"
    ],
    "type":"object",
    "properties":{
        "Code":{
            "type":"string",
            "description":"The 10 character code for the threshold level. Must be unique."
        },
        "Color":{
            "type":"string",
            "description":"The Hex representation for the color e.g. 0xFFFFFF."
        },
        "CostRange":{
            "type":"number",
            "description":"The cost range of the threshold level.",
            "format":"double"
        },
        "CreateDate":{
            "type":"string",
            "description":"The date this threshold level was created.",
            "format":"date-time"
        },
        "CreateUser":{
            "type":"string",
            "description":"The name of the user that created the threshold level."
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date this threshold level was last updated.",
            "format":"date-time"
        },
        "LastUpdateUser":{
            "type":"string",
            "description":"The name of the user that last updated the threshold level."
        },
        "Level":{
            "type":"integer",
            "description":"The valid values are between 0 and 9. Defines a level for the Risk Threshold.",
            "format":"int32"
        },
        "Name":{
            "type":"string",
            "description":"The 40 character name for the threshold level. Does not need to be unique."
        },
        "ObjectId":{
            "type":"integer",
            "description":"The unique ID generated by the system.",
            "format":"int32"
        },
        "ProbabilityRange":{
            "type":"number",
            "description":"The probability range of the threshold level.",
            "format":"double"
        },
        "Range":{
            "type":"string",
            "description":"The user defined range."
        },
        "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"
        },
        "ScheduleRange":{
            "type":"number",
            "description":"The schedule range of the threshold level.",
            "format":"double"
        },
        "ThresholdType":{
            "type":"string",
            "description":"The type of Risk Threshold. Valid types are 'Probability', 'Tolerance', 'Schedule', 'Cost', 'Relative Schedule', 'Relative Cost' and 'User Defined'."
        },
        "ToleranceRange":{
            "type":"integer",
            "description":"The tolerance range of the threshold level.",
            "format":"int32"
        }
    },
    "description":"RiskThresholdLevel 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