Skip to main content
PUT
/
v1
/
populations
/
{populationTagId}
Update Population
curl --request PUT \
  --url https://localtest.mindbridge.ai/api/v1/populations/{populationTagId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "version": 123,
  "name": "<string>",
  "category": "<string>",
  "condition": {
    "type": "GROUP",
    "operator": "AND",
    "conditions": [
      "<unknown>"
    ]
  },
  "description": "<string>",
  "reasonForChange": "<string>",
  "disabled": true,
  "displayCurrencyCode": "<string>",
  "displayLocale": "<string>"
}
'
{
  "version": 123,
  "analysisTypeId": {},
  "name": "<string>",
  "category": "<string>",
  "condition": {
    "type": "GROUP",
    "operator": "AND",
    "conditions": [
      "<unknown>"
    ]
  },
  "legacyFilterFormat": true,
  "id": {},
  "creationDate": "2023-11-07T05:31:56Z",
  "lastModifiedDate": "2023-11-07T05:31:56Z",
  "createdUserInfo": {
    "userId": {},
    "userName": "<string>"
  },
  "lastModifiedUserInfo": {
    "userId": {},
    "userName": "<string>"
  },
  "libraryId": {},
  "engagementId": {},
  "derivedFromLibrary": true,
  "disabledForAnalysisIds": [
    {}
  ],
  "promotedFromAnalysisId": {},
  "analysisId": {},
  "derivedFromEngagement": true,
  "basePopulationId": {},
  "description": "<string>",
  "clonedFrom": {},
  "reasonForChange": "<string>",
  "disabled": true,
  "displayCurrencyCode": "<string>",
  "displayLocale": "<string>"
}

Authorizations

Authorization
string
header
required

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

Path Parameters

populationTagId
string
required

Body

application/json
version
integer<int64>
required

Indicates the data integrity version to ensure data consistency.

name
string
required

The name of the population.

Required string length: 1 - 80
Pattern: \s*\S+.*
category
string
required

The category of the population.

Required string length: 1 - 80
Pattern: \s*\S+.*
condition
Filter Group Condition · object
required

The filter condition used to determine which entries are included in the population.

description
string

A description of the population.

Maximum string length: 250
reasonForChange
string

The reason for the latest change made to the population.

Maximum string length: 250
disabled
boolean
displayCurrencyCode
string

The ISO 4217 three-digit currency code that determines how currency values are formatted. Defaults to USD if not specified.

displayLocale
string

The ISO 639 locale identifier used to format display values. Defaults to en-us if not specified.

Response

OK

version
integer<int64>
required

Indicates the data integrity version to ensure data consistency.

analysisTypeId
object
required
name
string
required

The name of the population.

Required string length: 1 - 80
Pattern: \s*\S+.*
category
string
required

The category of the population.

Required string length: 1 - 80
Pattern: \s*\S+.*
condition
Filter Group Condition · object
required

The filter condition used to determine which entries are included in the population.

legacyFilterFormat
boolean
required

If true, this population uses a legacy filter format that cannot be represented in the current condition format.

id
object

The unique object identifier.

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

Details about the user who created the object.

lastModifiedUserInfo
User Info · object

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

libraryId
object

The ID of the parent library.

engagementId
object

The ID of the parent engagement.

derivedFromLibrary
boolean

Indicates that the engagement population was derived from a library.

disabledForAnalysisIds
object[]

Lists the analysis IDs where the engagement population is disabled.

promotedFromAnalysisId
object

Identifies the analysis from which the engagement population was promoted.

analysisId
object

The ID of the parent analysis.

derivedFromEngagement
boolean

Indicates whether the analysis population was derived from an engagement.

basePopulationId
object

The ID of the population the current population is based on.

description
string

A description of the population.

Maximum string length: 250
clonedFrom
object

Identifies the population the current population was cloned from.

reasonForChange
string

The reason for the latest change made to the population.

Maximum string length: 250
disabled
boolean
displayCurrencyCode
string

The ISO 4217 three-digit currency code that determines how currency values are formatted. Defaults to USD if not specified.

displayLocale
string

The ISO 639 locale identifier used to format display values. Defaults to en-us if not specified.