Update Library - MindBridge Documentation

Documentation Index

Fetch the complete documentation index at: /llms.txt

Use this file to discover all available pages before exploring further.

PUT

/v1/libraries/{libraryId}

Update Library

cURL

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

Python Example

import requests

url = "https://{tenant}.mindbridge.ai/api/v1/libraries/{libraryId}"

payload = {
    "version": 123,
    "name": "<string>",
    "warningsDismissed": True,
    "analysisTypeIds": ["<string>"],
    "controlPointSelectionPermission": True,
    "controlPointWeightPermission": True,
    "controlPointSettingsPermission": True,
    "riskScoreAndGroupsSelectionPermission": True,
    "archived": True,
    "defaultDelimiter": "<string>",
    "riskRangeEditPermission": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

JavaScript Example

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    version: 123,
    name: '<string>',
    warningsDismissed: true,
    analysisTypeIds: ['<string>'],
    controlPointSelectionPermission: true,
    controlPointWeightPermission: true,
    controlPointSettingsPermission: true,
    riskScoreAndGroupsSelectionPermission: true,
    archived: true,
    defaultDelimiter: '<string>',
    riskRangeEditPermission: true
  })
};

fetch('https://{tenant}.mindbridge.ai/api/v1/libraries/{libraryId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

PHP Example

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenant}.mindbridge.ai/api/v1/libraries/{libraryId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'version' => 123,
    'name' => '<string>',
    'warningsDismissed' => true,
    'analysisTypeIds' => [
        '<string>'
    ],
    'controlPointSelectionPermission' => true,
    'controlPointWeightPermission' => true,
    'controlPointSettingsPermission' => true,
    'riskScoreAndGroupsSelectionPermission' => true,
    'archived' => true,
    'defaultDelimiter' => '<string>',
    'riskRangeEditPermission' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
?>

Go Example

package main

import (
    "fmt"
    "strings"
    "net/http"
    "io"
)

func main() {

url := "https://{tenant}.mindbridge.ai/api/v1/libraries/{libraryId}"

payload := strings.NewReader("{\n  \"version\": 123,\n  \"name\": \"<string>\",\n  \"warningsDismissed\": true,\n  \"analysisTypeIds\": [\n    \"<string>\"\n  ],\n  \"controlPointSelectionPermission\": true,\n  \"controlPointWeightPermission\": true,\n  \"controlPointSettingsPermission\": true,\n  \"riskScoreAndGroupsSelectionPermission\": true,\n  \"archived\": true,\n  \"defaultDelimiter\": \"<string>\",\n  \"riskRangeEditPermission\": true\}")

req, _ := http.NewRequest("PUT", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
    req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
    body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))
}

Response Example

{
  "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.