Edit TB custom field

PATCH /api2/v1/termBases/customFields/{id}

Edit TB custom field

cURL

curl --request PATCH \
  --url https://cloud.memsource.com/web/api2/v1/termBases/customFields/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fieldName": "Usage notes",
  "values": [
    "<string>"
  ]
}
'

200

{
  "fieldName": "<string>",
  "id": "<string>",
  "level": "TERM",
  "type": "SINGLE_SELECT",
  "values": [
    "<string>"
  ]
}

Authorizations

ApiTokenOAuth2

Authorization · string · header · required

Get a token from auth/login endpoint and then pass it in the Authorization HTTP header in every subsequent API call. For more information visit our help center.

Path Parameters

id · string · required

Body

application/json

DTO for editing a term base custom field

fieldName · string · required

Name of the custom field

Required string length: 1 - 100

Pattern: .*\S.*

Example:

"Usage notes"

values · string[]

Possible values for select type fields. Required for type SINGLE_SELECT and MULTI_SELECT

Maximum array length: 100

Response

200

application/json

successful operation

DTO representing a term base custom field

fieldName · string

Name of the custom field

id · string

Unique identifier of the custom field

level · enum<string>

Level of the custom field

Available options: TERM, CONCEPT

Example:

"TERM"

type · enum<string>

Type of the custom field

Available options: STRING, NUMBER, DATE, BOOLEAN, SINGLE_SELECT, MULTI_SELECT, URL

Example:

"SINGLE_SELECT"

values · string[]

List of possible values for select type fields