Skip to main content
POST
/
v3
/
data_point_choices
/
replace
Replace choices of a data point
curl --request POST \
  --url https://{region}.affinda.com/v3/data_point_choices/replace \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "dataPoint": "XprEvgai",
  "collection": "mEFayXdO",
  "organization": "mEFayXdO",
  "choices": [
    {
      "value": "USD",
      "label": "USD",
      "synonyms": [
        "<string>"
      ],
      "description": "<string>"
    }
  ]
}'
{
  "dataPoint": "XprEvgai",
  "collection": "mEFayXdO",
  "organization": "mEFayXdO",
  "choices": [
    {
      "id": 1,
      "value": "USD",
      "label": "USD",
      "synonyms": [
        "<string>"
      ],
      "description": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Basic authentication using an API key, e.g. {Authorization: Bearer aff_0bb4fbdf97b7e4111ff6c0015471094155f91}. You can find your API key within the Settings page of the Affinda web app. You can obtain an API key by signing up for a free trial.

Body

application/json

Request body for replacing choices of a data point. Either collection or organization is required.

​
dataPoint
string
required

Uniquely identify a data point.

Example:

"XprEvgai"

​
choices
object[]
required

Incoming choices to replace existing choices of a data point. Existing choices and incoming choices are matched base on their value. New value will be created, existing value will be updated, and value not in incoming choices will be deleted.

​
collection
string

Uniquely identify a collection.

Example:

"mEFayXdO"

​
organization
string

Uniquely identify an organization.

Example:

"mEFayXdO"

Response

Successfully replaced choices of a data point.

​
dataPoint
string
required

Uniquely identify a data point.

Example:

"XprEvgai"

​
collection
string | null
required

Uniquely identify a collection.

Example:

"mEFayXdO"

​
organization
string | null
required

Uniquely identify an organization.

Example:

"mEFayXdO"

​
choices
object[]
required