Skip to main content
POST
/
v1
/
risk-ranges
Create Risk Range
curl --request POST \
  --url https://{tenant}.mindbridge.ai/api/v1/risk-ranges \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "libraryId": "<string>",
  "analysisTypeId": "<string>",
  "name": "<string>",
  "low": {
    "lowThreshold": 5000,
    "highThreshold": 5000
  },
  "medium": {
    "lowThreshold": 5000,
    "highThreshold": 5000
  },
  "high": {
    "lowThreshold": 5000,
    "highThreshold": 5000
  },
  "description": "<string>"
}
'
{
  "id": "<string>",
  "version": 123,
  "low": {
    "lowThreshold": 5000,
    "highThreshold": 5000
  },
  "medium": {
    "lowThreshold": 5000,
    "highThreshold": 5000
  },
  "high": {
    "lowThreshold": 5000,
    "highThreshold": 5000
  },
  "system": true,
  "libraryId": "<string>",
  "engagementId": "<string>",
  "analysisTypeId": "<string>",
  "name": "<string>",
  "description": "<string>"
}

Authorizations

Authorization
string
header
required

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

Body

application/json
libraryId
string
required

Identifies the library associated with this risk range.

analysisTypeId
string
required

Identifies the analysis type associated with this risk range.

name
string
required

The name of the risk range.

Maximum string length: 80
low
Risk Range Bounds · object

The low range bounds.

medium
Risk Range Bounds · object

The medium range bounds.

high
Risk Range Bounds · object

The high range bounds.

description
string

The description of the risk range.

Maximum string length: 250

Response

201 - application/json

Created

id
string

The unique object identifier.

version
integer<int64>

Data integrity version to ensure data consistency.

low
Risk Range Bounds · object

The low range bounds.

medium
Risk Range Bounds · object

The medium range bounds.

high
Risk Range Bounds · object

The high range bounds.

system
boolean

Indicates whether or not the risk ranges are a MindBridge system risk range.

libraryId
string

Identifies the library associated with this risk range.

engagementId
string

Identifies the engagement associated with this risk range.

analysisTypeId
string

Identifies the analysis type associated with this risk range.

name
string

The name of the risk range.

description
string

The description of the risk range.