Jump to

• Request
• Response

Batch Update Risk Matrices

put

/api/restapi/riskMatrix/batch

Send a request to this endpoint to update one or more risk matrixes.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : List<ApiEntityRiskMatrixInput>

Type: array

Title: List<ApiEntityRiskMatrixInput>

Show Source

• Array of: object ApiEntityRiskMatrixInput
  Title: ApiEntityRiskMatrixInput

  This entity represents a RiskMatrix object, a unique RiskMatrix object can be identified by the following combinations of the fields.

  • riskMatrixId
  • matrixName,projectId
  • matrixName,projectCode,workspaceCode

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

Nested Schema : ApiEntityRiskMatrixInput

Type: object

Title: ApiEntityRiskMatrixInput

This entity represents a RiskMatrix object, a unique RiskMatrix object can be identified by the following combinations of the fields.

• riskMatrixId
• matrixName,projectId
• matrixName,projectCode,workspaceCode

Show Source

• matrixDescription: string
  Minimum Length: 0

  Maximum Length: 4000

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

  Maximum Length: 60

  The name of the risk scoring matrix.
• 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.
• 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(required): array scoreTypes
  List of risk types associated with the risk matrix.
• tolerances: array tolerances
  List of risk tolerances associated with the risk matrix.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

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

{
    "title":"ApiEntityRiskMatrixInput",
    "required":[
        "matrixName",
        "scoreTypes",
        "workspaceId"
    ],
    "type":"object",
    "properties":{
        "pushDownType":{
            "type":"string",
            "description":"The push down type of the risk matrix.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "MANUAL",
                "AUTOMATIC"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The workspace that contains the risk matrix.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "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/ApiEntityRiskMatrixScoreInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "matrixName":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The name of the risk scoring matrix.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "tolerances":{
            "type":"array",
            "description":"List of risk tolerances associated with the risk matrix.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityRiskMatrixToleranceInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "scoreTypes":{
            "type":"array",
            "description":"List of risk types associated with the risk matrix.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityRiskMatrixScoreTypeInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "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"
            ]
        },
        "programCode":{
            "maxLength":60,
            "type":"string",
            "description":"The unique identifier for a program set by the user who created the program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "programId":{
            "type":"integer",
            "description":"The unique identifier for the program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "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"
            ]
        }
    },
    "description":"This entity represents a RiskMatrix object, a unique RiskMatrix object can be identified by the following combinations of the fields.<ul><li>riskMatrixId</li><li>matrixName,projectId</li><li>matrixName,projectCode,workspaceCode</li>",
    "exampleSetFlag":false
}

Nested Schema : scores

Type: array

List of risk scores associated with the risk matrix.

Show Source

• Array of: object ApiEntityRiskMatrixScoreInput
  Title: ApiEntityRiskMatrixScoreInput

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

Nested Schema : scoreTypes

Type: array

List of risk types associated with the risk matrix.

Show Source

• Array of: object ApiEntityRiskMatrixScoreTypeInput
  Title: ApiEntityRiskMatrixScoreTypeInput

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

Nested Schema : tolerances

Type: array

List of risk tolerances associated with the risk matrix.

Show Source

• Array of: object ApiEntityRiskMatrixToleranceInput
  Title: ApiEntityRiskMatrixToleranceInput

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

Nested Schema : ApiEntityRiskMatrixScoreInput

Type: object

Title: ApiEntityRiskMatrixScoreInput

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.
• probabilityThresholdLevel(required): integer (int32)
  Minimum Value: 1

  Maximum Value: 9

  The level at which threshold probability is measured.
• riskMatrixId(required): 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.

{
    "title":"ApiEntityRiskMatrixScoreInput",
    "required":[
        "probabilityThresholdLevel",
        "riskMatrixId"
    ],
    "type":"object",
    "properties":{
        "riskMatrixId":{
            "type":"integer",
            "description":"The unique identifier of a risk scoring matrix.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "riskMatrixScoreId":{
            "type":"integer",
            "description":"The unique identifier of a risk matrix score.",
            "format":"int64",
            "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"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "probabilityThresholdLevel":{
            "maximum":9,
            "minimum":1,
            "type":"integer",
            "description":"The level at which threshold probability is measured.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityRiskMatrixScoreTypeInput

Type: object

Title: ApiEntityRiskMatrixScoreTypeInput

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.
• riskMatrixId(required): integer (int64)
  The unique identifier for the risk scoring matrix.
• riskMatrixScoreTypeId: integer (int64)
  The unique identifier of a risk matrix score type.
• riskScoreTypeId(required): 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.

{
    "title":"ApiEntityRiskMatrixScoreTypeInput",
    "required":[
        "riskMatrixId",
        "riskScoreTypeId"
    ],
    "type":"object",
    "properties":{
        "riskMatrixId":{
            "type":"integer",
            "description":"The unique identifier for the risk scoring matrix.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "riskMatrixScoreTypeId":{
            "type":"integer",
            "description":"The unique identifier of a risk matrix score type.",
            "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"
            ]
        },
        "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"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityRiskMatrixToleranceInput

Type: object

Title: ApiEntityRiskMatrixToleranceInput

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(required): string
  Minimum Length: 1

  Maximum Length: 6

  Color that represents the urgency of the risk.
• riskMatrixId(required): integer (int64)
  The unique identifier for the risk matrix.
• riskMatrixToleranceId: integer (int64)
  The unique identifier of a matrix tolerance.
• value(required): number (double)
  A risk matrix tolerance value.

{
    "title":"ApiEntityRiskMatrixToleranceInput",
    "required":[
        "color",
        "riskMatrixId",
        "value"
    ],
    "type":"object",
    "properties":{
        "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"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        }
    },
    "exampleSetFlag":false
}

Examples

Select an example Batch Update Risk Matrices Using Risk Matrix IDs

Back to Top

Response

200 Response

A collection of object IDs mapped to a canonical link of the object with corresponding warning messages if any warnings were generated while processing the update request. For example - {"links":{"1":"https://[host]:[port]/api/restapi/[object]/1","2":"https://[host]:[port]/api/restapi/[object]/2"},"warnings":[{"primaryKeyName":"objectIdFieldName","uniqueFieldName":"object_code_01","uniqueFieldValue":"objectCodeFieldName","primaryKeyValue":1,"warningMessages":["warning_message_1","warning_message_2"]}]}

400 Response

Invalid input.

Back to Top