Analysis Type Configuration

Update

Update an existing analysis type configuration by its ID.

The configurable properties of an analysis type configuration are grouped into Risk Groups. They can be configured as follows:

Risk groups can be enabled and disabled by setting the disabled property. Only engagement-level analysis type configuration can be disabled.
The risk range for use by the risk group can be set by the selectedRiskRange, and must also be included in the list of applicableRiskRanges.
A filter field can optionally be set to limit the risk group to only apply to a set of accounts, rather than all accounts.
The control point weights can be adjusted by setting the value of the controlPointWeights key-value map, where the key is the control point’s symbolic name. Setting a control point weight to 0 disables the control point within the risk group.

Additionally, analysis type configurations cannot be updated if:

The system or template properties are true.
The analysis type configuration is at the analysis level, with a defined analysisId.

Permissions

api.analysis-type-configuration.write

PUT

analysis-type-configuration

{analysisTypeConfigurationId}

Update

curl --request PUT \
  --url https://{tenant}.mindbridge.ai/api/v1/analysis-type-configuration/{analysisTypeConfigurationId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "version": 123,
  "system": true,
  "configuration": {
    "riskGroups": [
      {
        "disabled": true,
        "id": "<string>",
        "selectedRiskRange": "<string>",
        "applicableRiskRanges": [
          "<string>"
        ],
        "filter": {
          "values": [
            "<string>"
          ]
        },
        "controlPointWeights": {}
      }
    ]
  }
}
'

{
  "id": "<string>",
  "version": 123,
  "creationDate": "2023-11-07T05:31:56Z",
  "lastModifiedDate": "2023-11-07T05:31:56Z",
  "createdUserInfo": {
    "userId": "<string>",
    "userName": "<string>"
  },
  "lastModifiedUserInfo": {
    "userId": "<string>",
    "userName": "<string>"
  },
  "system": true,
  "libraryId": "<string>",
  "engagementId": "<string>",
  "analysisId": "<string>",
  "analysisTypeId": "<string>",
  "configuration": {
    "riskGroups": [
      {
        "disabled": true,
        "id": "<string>",
        "system": true,
        "analysisTypeId": "<string>",
        "selectedRiskRange": "<string>",
        "applicableRiskRanges": [
          "<string>"
        ],
        "filter": {
          "values": [
            "<string>"
          ]
        },
        "controlPointWeights": {},
        "controlPointBundleVersion": "<string>",
        "name": {},
        "description": {},
        "category": {}
      }
    ]
  },
  "controlPointBundleVersion": "<string>",
  "template": true
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

analysisTypeConfigurationId

string

required

Body

application/json

version

integer<int64>

required

Data integrity version to ensure data consistency.

system

boolean

configuration

Analysis Config · object

The configuration details for this analysis type.

Show child attributes

Response

200 - application/json

string

The unique object identifier.

version

integer<int64>

Data integrity version to ensure data consistency.

creationDate

string<date-time>

The date that the object was originally created.

lastModifiedDate

string<date-time>

The date that the object was last updated or modified.

createdUserInfo

User Info · object

read-only

Details about the user who created the object.

Show child attributes

lastModifiedUserInfo

User Info · object

read-only

Details about the user who last modified or updated the object.

Show child attributes

system

boolean

libraryId

string

Identifies the library associated with this configuration.

engagementId

string

Identifies the associated engagement.

analysisId

string

Identifies the analysis associated with this configuration.

analysisTypeId

string

Identifies the type of analysis.

configuration

Analysis Config · object

The configuration details for this analysis type.

Show child attributes

controlPointBundleVersion

string

The version of the control point bundle used in this configuration.

template

boolean

Indicates whether this configuration is a template.

Overview

⌘I

Update

curl --request PUT \
  --url https://{tenant}.mindbridge.ai/api/v1/analysis-type-configuration/{analysisTypeConfigurationId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "version": 123,
  "system": true,
  "configuration": {
    "riskGroups": [
      {
        "disabled": true,
        "id": "<string>",
        "selectedRiskRange": "<string>",
        "applicableRiskRanges": [
          "<string>"
        ],
        "filter": {
          "values": [
            "<string>"
          ]
        },
        "controlPointWeights": {}
      }
    ]
  }
}
'

{
  "id": "<string>",
  "version": 123,
  "creationDate": "2023-11-07T05:31:56Z",
  "lastModifiedDate": "2023-11-07T05:31:56Z",
  "createdUserInfo": {
    "userId": "<string>",
    "userName": "<string>"
  },
  "lastModifiedUserInfo": {
    "userId": "<string>",
    "userName": "<string>"
  },
  "system": true,
  "libraryId": "<string>",
  "engagementId": "<string>",
  "analysisId": "<string>",
  "analysisTypeId": "<string>",
  "configuration": {
    "riskGroups": [
      {
        "disabled": true,
        "id": "<string>",
        "system": true,
        "analysisTypeId": "<string>",
        "selectedRiskRange": "<string>",
        "applicableRiskRanges": [
          "<string>"
        ],
        "filter": {
          "values": [
            "<string>"
          ]
        },
        "controlPointWeights": {},
        "controlPointBundleVersion": "<string>",
        "name": {},
        "description": {},
        "category": {}
      }
    ]
  },
  "controlPointBundleVersion": "<string>",
  "template": true
}