Jump to

• Request
• Response

Read RiskThresholds

get

/riskThreshold

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

Type: array

Title: List<RiskThreshold>

Show Source

• Array of: object RiskThreshold
  Title: RiskThreshold

  RiskThreshold Entity

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

Nested Schema : RiskThreshold

Type: object

Title: RiskThreshold

RiskThreshold Entity

Show Source

• CreateDate: string (date-time)
  The date this risk score type was created.
• CreateUser: string
  The name of the user that created the risk score type.
• LastUpdateDate: string (date-time)
  The date this risk score type was last updated.
• LastUpdateUser: string
  The name of the user that last updated the risk score type.
• Level: integer (int32)
  The number of Risk Threshold Levels. There are between two and nine.
• Name(required): string
  The name of the risk score type.
• ObjectId: integer (int32)
  The unique ID generated by the system.
• ThresholdType: string
  The type of Risk Threshold. Valid types are 'Probability', 'Tolerance', 'Schedule', 'Cost', 'Relative Schedule', 'Relative Cost' and 'User Defined'

{
    "title":"RiskThreshold",
    "required":[
        "Name"
    ],
    "type":"object",
    "properties":{
        "CreateDate":{
            "type":"string",
            "description":"The date this risk score type was created.",
            "format":"date-time"
        },
        "CreateUser":{
            "type":"string",
            "description":"The name of the user that created the risk score type."
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date this risk score type was last updated.",
            "format":"date-time"
        },
        "LastUpdateUser":{
            "type":"string",
            "description":"The name of the user that last updated the risk score type."
        },
        "Level":{
            "type":"integer",
            "description":"The number of Risk Threshold Levels. There are between two and nine.",
            "format":"int32"
        },
        "Name":{
            "type":"string",
            "description":"The name of the risk score type."
        },
        "ObjectId":{
            "type":"integer",
            "description":"The unique ID generated by the system.",
            "format":"int32"
        },
        "ThresholdType":{
            "type":"string",
            "description":"The type of Risk Threshold. Valid types are 'Probability', 'Tolerance', 'Schedule', 'Cost', 'Relative Schedule', 'Relative Cost' and 'User Defined'"
        }
    },
    "description":"RiskThreshold 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