Create Population - MindBridge Documentation

Documentation Index

Fetch the complete documentation index at: /llms.txt

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

Create Population

cURL

curl --request POST \
  --url https://{tenant}.mindbridge.ai/api/v1/populations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '\
{\
  "analysisTypeId": "<string>",\
  "name": "<string>",\
  "category": "<string>",\
  "condition": {\
    "type": "GROUP",\
    "conditions": [\
      {}\
    ]\
  },\
  "libraryId": "<string>",\
  "analysisId": "<string>",\
  "basePopulationId": "<string>",\
  "description": "<string>",\
  "disabled": true,\
  "displayCurrencyCode": "<string>",\
  "displayLocale": "<string>"\
}\
'

Python

import requests

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

payload = {
    "analysisTypeId": "<string>",
    "name": "<string>",
    "category": "<string>",
    "condition": {
        "type": "GROUP",
        "conditions": [{}]
    },
    "libraryId": "<string>",
    "analysisId": "<string>",
    "basePopulationId": "<string>",
    "description": "<string>",
    "disabled": True,
    "displayCurrencyCode": "<string>",
    "displayLocale": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

JavaScript

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    analysisTypeId: '<string>',
    name: '<string>',
    category: '<string>',
    condition: {type: 'GROUP', conditions: [{}]},
    libraryId: '<string>',
    analysisId: '<string>',
    basePopulationId: '<string>',
    description: '<string>',
    disabled: true,
    displayCurrencyCode: '<string>',
    displayLocale: '<string>'
  })
};

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

PHP

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenant}.mindbridge.ai/api/v1/populations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'analysisTypeId' => '<string>',
    'name' => '<string>',
    'category' => '<string>',
    'condition' => [
        'type' => 'GROUP',
        'conditions' => [
                [

]
        ]
    ],
    'libraryId' => '<string>',
    'analysisId' => '<string>',
    'basePopulationId' => '<string>',
    'description' => '<string>',
    'disabled' => true,
    'displayCurrencyCode' => '<string>',
    'displayLocale' => '<string>'
  ]),
  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

package main

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

func main() {

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

payload := strings.NewReader("{\n  \"analysisTypeId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"category\": \"<string>\",\n  \"condition\": {\n    \"type\": \"GROUP\",\n    \"conditions\": [\n      {}\n    ]\n  },\n  \"libraryId\": \"<string>\",\n  \"analysisId\": \"<string>\",\n  \"basePopulationId\": \"<string>\",\n  \"description\": \"<string>\",\n  \"disabled\": true,\n  \"displayCurrencyCode\": \"<string>\",\n  \"displayLocale\": \"<string>\"}")

req, _ := http.NewRequest("POST", 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))
}

Unirest (Java)

HttpResponse<String> response = Unirest.post("https://{tenant}.mindbridge.ai/api/v1/populations")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"analysisTypeId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"category\": \"<string>\",\n  \"condition\": {\n    \"type\": \"GROUP\",\n    \"conditions\": [\n      {}\n    ]\n  },\n  \"libraryId\": \"<string>\",\n  \"analysisId\": \"<string>\",\n  \"basePopulationId\": \"<string>\",\n  \"description\": \"<string>\",\n  \"disabled\": true,\n  \"displayCurrencyCode\": \"<string>\",\n  \"displayLocale\": \"<string>\"}")
  .asString();

Ruby

require 'uri'
require 'net/http'

url = URI("https://{tenant}.mindbridge.ai/api/v1/populations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"analysisTypeId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"category\": \"<string>\",\n  \"condition\": {\n    \"type\": \"GROUP\",\n    \"conditions\": [\n      {}\n    ]\n  },\n  \"libraryId\": \"<string>\",\n  \"analysisId\": \"<string>\",\n  \"basePopulationId\": \"<string>\",\n  \"description\": \"<string>\",\n  \"disabled\": true,\n  \"displayCurrencyCode\": \"<string>\",\n  \"displayLocale\": \"<string>\"}"

response = http.request(request)
puts response.read_body

201 - Created 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>"
  },
  "analysisTypeId": "<string>",
  "libraryId": "<string>",
  "engagementId": "<string>",
  "derivedFromLibrary": true,
  "disabledForAnalysisIds": [
    "<string>"
  ],
  "promotedFromAnalysisId": "<string>",
  "analysisId": "<string>",
  "derivedFromEngagement": true,
  "basePopulationId": "<string>",
  "name": "<string>",
  "category": "<string>",
  "description": "<string>",
  "clonedFrom": "<string>",
  "reasonForChange": "<string>",
  "disabled": true,
  "condition": {
    "type": "GROUP",
    "conditions": [
      {}
    ]
  },
  "legacyFilterFormat": true,
  "displayCurrencyCode": "<string>",
  "displayLocale": "<string>"
}