Libraries

Create Library

Create a new library.

If the selected account grouping and the account grouping associated with the selected base library are different, MindBridge can attempt to convert the settings (e.g., ratios, filters, populations, etc.) from the base library for use with the accounts in the selected account grouping. To do so, set the convertSettings property to true — any accounts that cannot be converted will be listed in the conversionWarnings field.

Note: If warningsDismissed is also set to true, these warnings will not be displayed in the UI.

Restrictions

The industry tags for the new library must be included in the selected account grouping.

Permissions

api.libraries.write

POST

libraries

Create Library

curl --request POST \
  --url https://{tenant}.mindbridge.ai/api/v1/libraries \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "basedOnLibraryId": "<string>",
  "warningsDismissed": true,
  "accountGroupingId": "<string>",
  "analysisTypeIds": [
    "<string>"
  ],
  "controlPointSelectionPermission": true,
  "controlPointWeightPermission": true,
  "controlPointSettingsPermission": true,
  "riskScoreAndGroupsSelectionPermission": true,
  "convertSettings": true,
  "defaultDelimiter": "<string>",
  "riskRangeEditPermission": true
}
'

{
  "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>"
  },
  "name": "<string>",
  "basedOnLibraryId": "<string>",
  "originalSystemLibraryId": "<string>",
  "warningsDismissed": true,
  "conversionWarnings": [
    {
      "entityType": "<string>",
      "entityId": "<string>",
      "identifier": "<string>",
      "values": [
        "<string>"
      ],
      "reason": "<string>",
      "suggestedValues": [
        "<string>"
      ],
      "problemCount": 123
    }
  ],
  "accountGroupingId": "<string>",
  "analysisTypeIds": [
    "<string>"
  ],
  "defaultDelimiter": "<string>",
  "controlPointSelectionPermission": true,
  "controlPointWeightPermission": true,
  "controlPointSettingsPermission": true,
  "riskScoreAndGroupsSelectionPermission": true,
  "riskRangeEditPermission": true,
  "system": true,
  "archived": true
}

Authorizations

Authorization

string

header

required

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

Body

application/json

name

string

required

The current name of the library.

Maximum string length: 80

basedOnLibraryId

string

required

Identifies the library that the new library is based on. This may be a user-created library or a MindBridge system library.

warningsDismissed

boolean

required

When set to true, any conversion warnings for this library will not be displayed in the Libraries tab in the UI.

accountGroupingId

string

required

Identifies the account grouping used.

analysisTypeIds

string[]

required

Identifies the analysis types used in the library.

Minimum array length: 1

controlPointSelectionPermission

boolean

required

When set to true, control points can be added or removed within each risk score.

controlPointWeightPermission

boolean

required

When set to true, the weight of each control point can be adjusted within each risk score.

controlPointSettingsPermission

boolean

required

When set to true, individual control point settings can be adjusted within each risk score.

riskScoreAndGroupsSelectionPermission

boolean

required

When set to true, risk scores and groups can be disabled, and accounts associated with risk scores can be edited.

riskScoreDisplay

enum<string>

required

Determines whether risk scores will be presented as percentages (%), or using High, Medium, and Low label indicators.

Available options:

HIGH_MEDIUM_LOW,

PERCENTAGE

convertSettings

boolean

Indicates whether or not settings from the selected base library should be converted for use with the selected account grouping.

defaultDelimiter

string

Identifies the default delimiter used in imported CSV files.

riskRangeEditPermission

boolean

Response

201 - application/json

Created

string

The unique object identifier.

version

integer<int64>

Indicates the 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

name

string

The current name of the library.

basedOnLibraryId

string

Identifies the library that the new library is based on. This may be a user-created library or a MindBridge system library.

originalSystemLibraryId

string

Identifies the original MindBridge-supplied library.

warningsDismissed

boolean

When set to true, any conversion warnings for this library will not be displayed in the Libraries tab in the UI.

conversionWarnings

object[]

A list of accounts that failed to convert the selected base library's setting to the selected account grouping.

Show child attributes

accountGroupingId

string

Identifies the account grouping used.

analysisTypeIds

string[]

Identifies the analysis types used in the library.

defaultDelimiter

string

Identifies the default delimiter used in imported CSV files.

controlPointSelectionPermission

boolean

When set to true, control points can be added or removed within each risk score.

controlPointWeightPermission

boolean

When set to true, the weight of each control point can be adjusted within each risk score.

controlPointSettingsPermission

boolean

When set to true, individual control point settings can be adjusted within each risk score.

riskScoreAndGroupsSelectionPermission

boolean

When set to true, risk scores and groups can be disabled, and accounts associated with risk scores can be edited.

riskRangeEditPermission

boolean

riskScoreDisplay

enum<string>

Determines whether risk scores will be presented as percentages (%), or using High, Medium, and Low label indicators.

Available options:

HIGH_MEDIUM_LOW,

PERCENTAGE

system

boolean

Indicates whether or not the library is a MindBridge system library.

archived

boolean

Indicates whether or not the library is archived. Archived libraries cannot be selected when creating an engagement.

Delete LibraryDelete an existing library, identified by its ID. Restrictions * System libraries cannot be deleted. * Libraries in use by engagements cannot be deleted. * Libraries that are used as the basis of other libraries cannot be deleted. ### Permissions - `api.libraries.delete`

⌘I

Create Library

curl --request POST \
  --url https://{tenant}.mindbridge.ai/api/v1/libraries \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "basedOnLibraryId": "<string>",
  "warningsDismissed": true,
  "accountGroupingId": "<string>",
  "analysisTypeIds": [
    "<string>"
  ],
  "controlPointSelectionPermission": true,
  "controlPointWeightPermission": true,
  "controlPointSettingsPermission": true,
  "riskScoreAndGroupsSelectionPermission": true,
  "convertSettings": true,
  "defaultDelimiter": "<string>",
  "riskRangeEditPermission": true
}
'

{
  "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>"
  },
  "name": "<string>",
  "basedOnLibraryId": "<string>",
  "originalSystemLibraryId": "<string>",
  "warningsDismissed": true,
  "conversionWarnings": [
    {
      "entityType": "<string>",
      "entityId": "<string>",
      "identifier": "<string>",
      "values": [
        "<string>"
      ],
      "reason": "<string>",
      "suggestedValues": [
        "<string>"
      ],
      "problemCount": 123
    }
  ],
  "accountGroupingId": "<string>",
  "analysisTypeIds": [
    "<string>"
  ],
  "defaultDelimiter": "<string>",
  "controlPointSelectionPermission": true,
  "controlPointWeightPermission": true,
  "controlPointSettingsPermission": true,
  "riskScoreAndGroupsSelectionPermission": true,
  "riskRangeEditPermission": true,
  "system": true,
  "archived": true
}