Jump to

• Request
• Response

View a Risk Score Type

get

/api/restapi/riskScoreType/{riskScoreTypeId}

This endpoint returns risk score types that meet the following requirements:

• The object has an ID that matches the value of the {riskScoreTypeId} path parameter.

Request

Path Parameters

• riskScoreTypeId(required): integer(int64)
  The system-generated identifier of a risk score type.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : ApiEntityRiskScoreType

Type: object

Title: ApiEntityRiskScoreType

Show Source

• associationType: string
  Allowed Values: [ "OWNED", "INHERITED" ]

  The type of association in the relationship between the risk score type and the workspace. Possible values are Owned and Inherited.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• programCode: string
  Maximum Length: 60

  The unique identifier for a program set by the user who created the program.
• programId: integer (int64)
  The unique identifier for the program.
• projectCode: string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project.The project object can also be identified by its unique criteria.
• pushDownType: string
  Allowed Values: [ "MANUAL", "AUTOMATIC" ]

  The push down type of the risk score.
• referencedScoreTypeId: integer (int64)
  The unique identifier of a copied score type.
• riskScoreThresholds: array riskScoreThresholds
  An array of the risk threshold values for a selected risk threshold.
• riskScoreTypeId: integer (int64)
  The unique identifier of a score type.
• riskScoreTypeName: string
  Minimum Length: 0

  Maximum Length: 255

  The name of the risk score type.
• scoreType: string
  Allowed Values: [ "PROBABILITY", "SCHEDULE", "RELATIVE_SCHEDULE", "COST", "RELATIVE_COST", "USER" ]

  The type of risk score.
• updateDate: string (date-time)
  Date when the record was last updated.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The code of a workspace associated to a risk score.
• workspaceId: integer (int64)
  The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.

{
    "title":"ApiEntityRiskScoreType",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The code of a workspace associated to a risk score.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "scoreType":{
            "type":"string",
            "description":"The type of risk score.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "PROBABILITY",
                "SCHEDULE",
                "RELATIVE_SCHEDULE",
                "COST",
                "RELATIVE_COST",
                "USER"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programId":{
            "type":"integer",
            "description":"The unique identifier for the program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "pushDownType":{
            "type":"string",
            "description":"The push down type of the risk score.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "MANUAL",
                "AUTOMATIC"
            ]
        },
        "associationType":{
            "type":"string",
            "description":"The type of association in the relationship between the risk score type and the workspace. Possible values are Owned and Inherited.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "OWNED",
                "INHERITED"
            ]
        },
        "programCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a program set by the user who created the program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "riskScoreTypeId":{
            "type":"integer",
            "description":"The unique identifier of a score type.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "riskScoreTypeName":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string",
            "description":"The name of the risk score type.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "riskScoreThresholds":{
            "type":"array",
            "description":"An array of the risk threshold values for a selected risk threshold.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityRiskScoreThreshold",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "referencedScoreTypeId":{
            "type":"integer",
            "description":"The unique identifier of a copied score type.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : riskScoreThresholds

Type: array

An array of the risk threshold values for a selected risk threshold.

Show Source

• Array of: object ApiEntityRiskScoreThreshold
  Title: ApiEntityRiskScoreThreshold

{
    "type":"array",
    "description":"An array of the risk threshold values for a selected risk threshold.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityRiskScoreThreshold",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityRiskScoreThreshold

Type: object

Title: ApiEntityRiskScoreThreshold

Show Source

• action: string
  Allowed Values: [ "DELETE" ]

  Provide a value for this field during object update to delete the particular nested entry in the list of risk score thresholds. A valid riskScoreThresholdId, riskScoreThresholdCode, or level value must be provided to perform deletion.
• color: string
  Minimum Length: 6

  Maximum Length: 6

  The color that represents the urgency of the risk.
• level: integer (int32)
  Minimum Value: 0

  Maximum Value: 10

  The level of the risk threshold.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• lower: number (double)
  The lower limit of the risk score threshold range.
• riskScoreThresholdCode: string
  Minimum Length: 0

  Maximum Length: 60

  The unique identifier for the risk scoring threshold.
• riskScoreThresholdId: integer (int64)
  The unique ID of the risk score threshold.
• riskScoreThresholdName: string
  Minimum Length: 0

  Maximum Length: 255

  The name of the risk threshold.
• riskScoreTypeId: integer (int64)
  The category to which the risk score belongs.
• riskScoreTypeName: string
  Minimum Length: 0

  Maximum Length: 255

  The name of the risk score type.
• stringValue: string
  Minimum Length: 0

  Maximum Length: 255

  The value of the string.
• updateDate: string (date-time)
  Date when the record was last updated.
• upper: number (double)
  The upper limit of the risk score threshold range.

{
    "title":"ApiEntityRiskScoreThreshold",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "stringValue":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string",
            "description":"The value of the string.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "level":{
            "maximum":"10",
            "minimum":"0",
            "type":"integer",
            "description":"The level of the risk threshold.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "color":{
            "maxLength":"6",
            "minLength":"6",
            "type":"string",
            "description":"The color that represents the urgency of the risk.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "lower":{
            "type":"number",
            "description":"The lower limit of the risk score threshold range.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "upper":{
            "type":"number",
            "description":"The upper limit of the risk score threshold range.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "action":{
            "type":"string",
            "description":"Provide a value for this field during object update to delete the particular nested entry in the list of risk score thresholds. A valid riskScoreThresholdId, riskScoreThresholdCode, or level value must be provided to perform deletion.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DELETE"
            ]
        },
        "riskScoreThresholdId":{
            "type":"integer",
            "description":"The unique ID of the risk score threshold.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "riskScoreTypeId":{
            "type":"integer",
            "description":"The category to which the risk score belongs.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "riskScoreTypeName":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string",
            "description":"The name of the risk score type.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "riskScoreThresholdCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The unique identifier for the risk scoring threshold.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "riskScoreThresholdName":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string",
            "description":"The name of the risk threshold.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

404 Response

The requested risk score type does not exist, or you do not have access to it.

Back to Top