Jump to

• Request
• Response

View all Risk Matrixes by Name in a Workspace Hierarchy

get

/api/restapi/riskMatrix/resolveRiskMatrix/workspace/{workspaceId}/riskMatrix/{matrixName}

Send a request to this endpoint to view a risk matrix associated with a name matching the value of the {matrixName} and the hierarchy of the workspace with an id matching the value of the {workspaceId}.

Request

Path Parameters

• matrixName(required): string
  The name of a risk matrix.
• workspaceId(required): integer(int64)
  WorkspaceId of RiskMatrix to be found

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : List<ApiEntityRiskMatrix>

Type: array

Title: List<ApiEntityRiskMatrix>

Show Source

• Array of: object ApiEntityRiskMatrix
  Title: ApiEntityRiskMatrix

{
    "title":"List<ApiEntityRiskMatrix>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityRiskMatrix",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityRiskMatrix

Type: object

Title: ApiEntityRiskMatrix

Show Source

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

  The type of association in the relationship between the risk matrix and the workspace. Possible values are Owned and Inherited.
• impactLevels: integer (int32)
  The degree to which a risk matrix is impacted.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• matrixDescription: string
  Minimum Length: 0

  Maximum Length: 4000

  The detailed summary of the risk scoring matrix.
• matrixName: string
  Minimum Length: 1

  Maximum Length: 60

  The name of the risk scoring matrix.
• probabilityLevels: integer (int32)
  A count of the number of levels (thresholds) for the probability score type associated with the matrix. This does not count the Negligible level.
• 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 matrix.
• referencedRiskMatrixId: integer (int64)
  Unique identifier of a risk matrix.
• riskMatrixId: integer (int64)
  The system-generated identifier of the risk matrix.
• riskScoreMatrixMethod: string
  Allowed Values: [ "HIGHEST", "AVERAGE_IMPACTS", "AVERAGE_INDIVIDUAL_SCORES" ]

  The type of calculation used to obtain an overall impact value. The valid values are Highest Impact and Average Impact.
• scores: array scores
  List of risk scores associated with the risk matrix.
• scoreTypes: array scoreTypes
  List of risk types associated with the risk matrix.
• tolerances: array tolerances
  List of risk tolerances associated with the risk matrix.
• updateDate: string (date-time)
  Date when the record was last updated.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The workspace that contains the risk matrix.

{
    "title":"ApiEntityRiskMatrix",
    "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 user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The workspace that contains the risk matrix.",
            "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 matrix.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "MANUAL",
                "AUTOMATIC"
            ]
        },
        "associationType":{
            "type":"string",
            "description":"The type of association in the relationship between the risk matrix 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"
            ]
        },
        "riskMatrixId":{
            "type":"integer",
            "description":"The system-generated identifier of the risk matrix.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "scores":{
            "type":"array",
            "description":"List of risk scores associated with the risk matrix.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityRiskMatrixScore",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "scoreTypes":{
            "type":"array",
            "description":"List of risk types associated with the risk matrix.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityRiskMatrixScoreType",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "tolerances":{
            "type":"array",
            "description":"List of risk tolerances associated with the risk matrix.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityRiskMatrixTolerance",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "matrixName":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The name of the risk scoring matrix.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "matrixDescription":{
            "maxLength":"4000",
            "minLength":"0",
            "type":"string",
            "description":"The detailed summary of the risk scoring matrix.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "riskScoreMatrixMethod":{
            "type":"string",
            "description":"The type of calculation used to obtain an overall impact value. The valid values are Highest Impact and Average Impact.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "HIGHEST",
                "AVERAGE_IMPACTS",
                "AVERAGE_INDIVIDUAL_SCORES"
            ]
        },
        "impactLevels":{
            "type":"integer",
            "description":"The degree to which a risk matrix is impacted.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "probabilityLevels":{
            "type":"integer",
            "description":"A count of the number of levels (thresholds) for the probability score type associated with the matrix. This does not count the Negligible level.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "referencedRiskMatrixId":{
            "type":"integer",
            "description":"Unique identifier of a risk matrix.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : scores

Type: array

List of risk scores associated with the risk matrix.

Show Source

• Array of: object ApiEntityRiskMatrixScore
  Title: ApiEntityRiskMatrixScore

{
    "type":"array",
    "description":"List of risk scores associated with the risk matrix.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityRiskMatrixScore",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : scoreTypes

Type: array

List of risk types associated with the risk matrix.

Show Source

• Array of: object ApiEntityRiskMatrixScoreType
  Title: ApiEntityRiskMatrixScoreType

{
    "type":"array",
    "description":"List of risk types associated with the risk matrix.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityRiskMatrixScoreType",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : tolerances

Type: array

List of risk tolerances associated with the risk matrix.

Show Source

• Array of: object ApiEntityRiskMatrixTolerance
  Title: ApiEntityRiskMatrixTolerance

{
    "type":"array",
    "description":"List of risk tolerances associated with the risk matrix.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityRiskMatrixTolerance",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityRiskMatrixScore

Type: object

Title: ApiEntityRiskMatrixScore

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 scores. A valid riskMatrixScoreId or probabilityThresholdLevel value must be provided to perform deletion.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• matrixName: string
  Maximum Length: 60

  The name of the risk scoring matrix.
• probabilityThresholdLevel: integer (int32)
  Minimum Value: 1

  Maximum Value: 9

  The level at which threshold probability is measured.
• riskMatrixId: integer (int64)
  The unique identifier of a risk scoring matrix.
• riskMatrixScoreId: integer (int64)
  The unique identifier of a risk matrix score.
• severityEight: integer (int32)
  Minimum Value: -1000000000

  Maximum Value: 1000000000

  The severity level of schedule and cost impacts in your risk scoring matrix.
• severityEightLabel: string
  Minimum Length: 0

  Maximum Length: 40

  The severity level of schedule and cost impacts in your risk scoring matrix.
• severityFive: integer (int32)
  Minimum Value: -1000000000

  Maximum Value: 1000000000

  The severity level of schedule and cost impacts in your risk scoring matrix.
• severityFiveLabel: string
  Minimum Length: 0

  Maximum Length: 40

  The severity level of schedule and cost impacts in your risk scoring matrix.
• severityFour: integer (int32)
  Minimum Value: -1000000000

  Maximum Value: 1000000000

  The severity level of schedule and cost impacts in your risk scoring matrix.
• severityFourLabel: string
  Minimum Length: 0

  Maximum Length: 40

  The severity level of schedule and cost impacts in your risk scoring matrix.
• severityNine: integer (int32)
  Minimum Value: -1000000000

  Maximum Value: 1000000000

  The severity level of schedule and cost impacts in your risk scoring matrix.
• severityNineLabel: string
  Minimum Length: 0

  Maximum Length: 40

  The severity level of schedule and cost impacts in your risk scoring matrix.
• severityOne: integer (int32)
  Minimum Value: -1000000000

  Maximum Value: 1000000000

  The severity level of schedule and cost impacts in your risk scoring matrix.
• severityOneLabel: string
  Minimum Length: 0

  Maximum Length: 40

  The severity level of schedule and cost impacts in your risk scoring matrix.
• severitySeven: integer (int32)
  Minimum Value: -1000000000

  Maximum Value: 1000000000

  The severity level of schedule and cost impacts in your risk scoring matrix.
• severitySevenLabel: string
  Minimum Length: 0

  Maximum Length: 40

  The severity level of schedule and cost impacts in your risk scoring matrix.
• severitySix: integer (int32)
  Minimum Value: -1000000000

  Maximum Value: 1000000000

  The severity level of schedule and cost impacts in your risk scoring matrix.
• severitySixLabel: string
  Minimum Length: 0

  Maximum Length: 40

  The severity level of schedule and cost impacts in your risk scoring matrix.
• severityThree: integer (int32)
  Minimum Value: -1000000000

  Maximum Value: 1000000000

  The severity level of schedule and cost impacts in your risk scoring matrix.
• severityThreeLabel: string
  Minimum Length: 0

  Maximum Length: 40

  The severity level of schedule and cost impacts in your risk scoring matrix.
• severityTwo: integer (int32)
  Minimum Value: -1000000000

  Maximum Value: 1000000000

  The severity level of schedule and cost impacts in your risk scoring matrix.
• severityTwoLabel: string
  Minimum Length: 0

  Maximum Length: 40

  The severity level of schedule and cost impacts in your risk scoring matrix.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityRiskMatrixScore",
    "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"
            ]
        },
        "action":{
            "type":"string",
            "description":"Provide a value for this field during object update to delete the particular nested entry in the list of scores. A valid riskMatrixScoreId or probabilityThresholdLevel value must be provided to perform deletion.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DELETE"
            ]
        },
        "riskMatrixId":{
            "type":"integer",
            "description":"The unique identifier of a risk scoring matrix.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "matrixName":{
            "maxLength":"60",
            "type":"string",
            "description":"The name of the risk scoring matrix.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "riskMatrixScoreId":{
            "type":"integer",
            "description":"The unique identifier of a risk matrix score.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "probabilityThresholdLevel":{
            "maximum":"9",
            "minimum":"1",
            "type":"integer",
            "description":"The level at which threshold probability is measured.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "severityOne":{
            "maximum":"1000000000",
            "minimum":"-1000000000",
            "type":"integer",
            "description":"The severity level of schedule and cost impacts in your risk scoring matrix.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "severityTwo":{
            "maximum":"1000000000",
            "minimum":"-1000000000",
            "type":"integer",
            "description":"The severity level of schedule and cost impacts in your risk scoring matrix.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "severityThree":{
            "maximum":"1000000000",
            "minimum":"-1000000000",
            "type":"integer",
            "description":"The severity level of schedule and cost impacts in your risk scoring matrix.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "severityFour":{
            "maximum":"1000000000",
            "minimum":"-1000000000",
            "type":"integer",
            "description":"The severity level of schedule and cost impacts in your risk scoring matrix.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "severityFive":{
            "maximum":"1000000000",
            "minimum":"-1000000000",
            "type":"integer",
            "description":"The severity level of schedule and cost impacts in your risk scoring matrix.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "severitySix":{
            "maximum":"1000000000",
            "minimum":"-1000000000",
            "type":"integer",
            "description":"The severity level of schedule and cost impacts in your risk scoring matrix.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "severitySeven":{
            "maximum":"1000000000",
            "minimum":"-1000000000",
            "type":"integer",
            "description":"The severity level of schedule and cost impacts in your risk scoring matrix.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "severityEight":{
            "maximum":"1000000000",
            "minimum":"-1000000000",
            "type":"integer",
            "description":"The severity level of schedule and cost impacts in your risk scoring matrix.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "severityNine":{
            "maximum":"1000000000",
            "minimum":"-1000000000",
            "type":"integer",
            "description":"The severity level of schedule and cost impacts in your risk scoring matrix.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "severityOneLabel":{
            "maxLength":"40",
            "minLength":"0",
            "type":"string",
            "description":"The severity level of schedule and cost impacts in your risk scoring matrix.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "severityTwoLabel":{
            "maxLength":"40",
            "minLength":"0",
            "type":"string",
            "description":"The severity level of schedule and cost impacts in your risk scoring matrix.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "severityThreeLabel":{
            "maxLength":"40",
            "minLength":"0",
            "type":"string",
            "description":"The severity level of schedule and cost impacts in your risk scoring matrix.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "severityFourLabel":{
            "maxLength":"40",
            "minLength":"0",
            "type":"string",
            "description":"The severity level of schedule and cost impacts in your risk scoring matrix.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "severityFiveLabel":{
            "maxLength":"40",
            "minLength":"0",
            "type":"string",
            "description":"The severity level of schedule and cost impacts in your risk scoring matrix.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "severitySixLabel":{
            "maxLength":"40",
            "minLength":"0",
            "type":"string",
            "description":"The severity level of schedule and cost impacts in your risk scoring matrix.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "severitySevenLabel":{
            "maxLength":"40",
            "minLength":"0",
            "type":"string",
            "description":"The severity level of schedule and cost impacts in your risk scoring matrix.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "severityEightLabel":{
            "maxLength":"40",
            "minLength":"0",
            "type":"string",
            "description":"The severity level of schedule and cost impacts in your risk scoring matrix.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "severityNineLabel":{
            "maxLength":"40",
            "minLength":"0",
            "type":"string",
            "description":"The severity level of schedule and cost impacts in your risk scoring matrix.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityRiskMatrixScoreType

Type: object

Title: ApiEntityRiskMatrixScoreType

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 scoreTypes. A valid riskMatrixScoreTypeId, riskScoreTypeId, or riskScoreTypeName value must be provided to perform deletion.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• matrixName: string
  Minimum Length: 1

  Maximum Length: 60

  The name of the risk scoring matrix.
• riskMatrixId: integer (int64)
  The unique identifier for the risk scoring matrix.
• riskMatrixScoreTypeId: integer (int64)
  The unique identifier of a risk matrix score type.
• riskScoreType: riskScoreType
  A risk score type.
• riskScoreTypeId: integer (int64)
  The unique identifier for the risk matrix score type.
• riskScoreTypeName: string
  Minimum Length: 0

  Maximum Length: 255

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

{
    "title":"ApiEntityRiskMatrixScoreType",
    "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"
            ]
        },
        "action":{
            "type":"string",
            "description":"Provide a value for this field during object update to delete the particular nested entry in the list of scoreTypes. A valid riskMatrixScoreTypeId, riskScoreTypeId, or riskScoreTypeName value must be provided to perform deletion.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DELETE"
            ]
        },
        "riskMatrixId":{
            "type":"integer",
            "description":"The unique identifier for the risk scoring matrix.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "riskScoreTypeId":{
            "type":"integer",
            "description":"The unique identifier for the risk matrix 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"
            ]
        },
        "matrixName":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The name of the risk scoring matrix.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "riskMatrixScoreTypeId":{
            "type":"integer",
            "description":"The unique identifier of a risk matrix score type.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "riskScoreType":{
            "description":"A risk score type.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityRiskScoreType"
                }
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : riskScoreType

A risk score type.

Match All

Show Source

• object ApiEntityRiskScoreType
  Title: ApiEntityRiskScoreType

{
    "description":"A risk score type.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityRiskScoreType"
        }
    ]
}

Nested 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
}

Nested Schema : ApiEntityRiskMatrixTolerance

Type: object

Title: ApiEntityRiskMatrixTolerance

Show Source

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

  Provide value for this field during object update to delete the particular nested entry in the list of tolerances. A valid riskMatrixToleranceId or value must be provided to perform deletion.
• color: string
  Minimum Length: 1

  Maximum Length: 6

  Color that represents the urgency of the risk.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• riskMatrixId: integer (int64)
  The unique identifier for the risk matrix.
• riskMatrixName: string
  Minimum Length: 1

  Maximum Length: 60

  The name of the risk scoring matrix.
• riskMatrixToleranceId: integer (int64)
  The unique identifier of a matrix tolerance.
• updateDate: string (date-time)
  Date when the record was last updated.
• value: number (double)
  A risk matrix tolerance value.

{
    "title":"ApiEntityRiskMatrixTolerance",
    "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"
            ]
        },
        "value":{
            "type":"number",
            "description":"A risk matrix tolerance value.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "color":{
            "maxLength":"6",
            "minLength":"1",
            "type":"string",
            "description":"Color that represents the urgency of the risk.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "action":{
            "type":"string",
            "description":"Provide value for this field during object update to delete the particular nested entry in the list of tolerances. A valid riskMatrixToleranceId or value must be provided to perform deletion.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DELETE"
            ]
        },
        "riskMatrixId":{
            "type":"integer",
            "description":"The unique identifier for the risk matrix.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "riskMatrixToleranceId":{
            "type":"integer",
            "description":"The unique identifier of a matrix tolerance.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "riskMatrixName":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The name of the risk scoring matrix.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

204 Response

Successful operation with no content.

404 Response

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

Back to Top