Create TB custom field
curl --request POST \
--url https://cloud.memsource.com/web/api2/v1/termBases/customFields \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"fieldName": "Usage notes",
"level": "TERM",
"type": "SINGLE_SELECT",
"values": [
"<string>"
]
}
'import requests
url = "https://cloud.memsource.com/web/api2/v1/termBases/customFields"
payload = {
"fieldName": "Usage notes",
"level": "TERM",
"type": "SINGLE_SELECT",
"values": ["<string>"]
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
fieldName: 'Usage notes',
level: 'TERM',
type: 'SINGLE_SELECT',
values: ['<string>']
})
};
fetch('https://cloud.memsource.com/web/api2/v1/termBases/customFields', 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://cloud.memsource.com/web/api2/v1/termBases/customFields",
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([
'fieldName' => 'Usage notes',
'level' => 'TERM',
'type' => 'SINGLE_SELECT',
'values' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://cloud.memsource.com/web/api2/v1/termBases/customFields"
payload := strings.NewReader("{\n \"fieldName\": \"Usage notes\",\n \"level\": \"TERM\",\n \"type\": \"SINGLE_SELECT\",\n \"values\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
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))
}HttpResponse<String> response = Unirest.post("https://cloud.memsource.com/web/api2/v1/termBases/customFields")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"fieldName\": \"Usage notes\",\n \"level\": \"TERM\",\n \"type\": \"SINGLE_SELECT\",\n \"values\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://cloud.memsource.com/web/api2/v1/termBases/customFields")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"fieldName\": \"Usage notes\",\n \"level\": \"TERM\",\n \"type\": \"SINGLE_SELECT\",\n \"values\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"fieldName": "<string>",
"id": "<string>",
"level": "TERM",
"type": "SINGLE_SELECT",
"values": [
"<string>"
]
}Custom Fields
Create TB custom field
POST
/
api2
/
v1
/
termBases
/
customFields
Create TB custom field
curl --request POST \
--url https://cloud.memsource.com/web/api2/v1/termBases/customFields \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"fieldName": "Usage notes",
"level": "TERM",
"type": "SINGLE_SELECT",
"values": [
"<string>"
]
}
'import requests
url = "https://cloud.memsource.com/web/api2/v1/termBases/customFields"
payload = {
"fieldName": "Usage notes",
"level": "TERM",
"type": "SINGLE_SELECT",
"values": ["<string>"]
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
fieldName: 'Usage notes',
level: 'TERM',
type: 'SINGLE_SELECT',
values: ['<string>']
})
};
fetch('https://cloud.memsource.com/web/api2/v1/termBases/customFields', 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://cloud.memsource.com/web/api2/v1/termBases/customFields",
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([
'fieldName' => 'Usage notes',
'level' => 'TERM',
'type' => 'SINGLE_SELECT',
'values' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://cloud.memsource.com/web/api2/v1/termBases/customFields"
payload := strings.NewReader("{\n \"fieldName\": \"Usage notes\",\n \"level\": \"TERM\",\n \"type\": \"SINGLE_SELECT\",\n \"values\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
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))
}HttpResponse<String> response = Unirest.post("https://cloud.memsource.com/web/api2/v1/termBases/customFields")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"fieldName\": \"Usage notes\",\n \"level\": \"TERM\",\n \"type\": \"SINGLE_SELECT\",\n \"values\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://cloud.memsource.com/web/api2/v1/termBases/customFields")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"fieldName\": \"Usage notes\",\n \"level\": \"TERM\",\n \"type\": \"SINGLE_SELECT\",\n \"values\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"fieldName": "<string>",
"id": "<string>",
"level": "TERM",
"type": "SINGLE_SELECT",
"values": [
"<string>"
]
}Authorizations
ApiTokenOAuth2
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.
Body
application/json
DTO for creating a new term base custom field
Name of the custom field
Required string length:
1 - 100Example:
"Usage notes"
Level of the custom field
Available options:
TERM, CONCEPT Example:
"TERM"
Type of the custom field
Available options:
STRING, NUMBER, DATE, BOOLEAN, SINGLE_SELECT, MULTI_SELECT, URL Example:
"SINGLE_SELECT"
Possible values for select type fields. Required for type SINGLE_SELECT and MULTI_SELECT. Each value must be not blank and less then 100 characters length
Maximum array length:
100Response
successful operation
DTO representing a term base custom field
Name of the custom field
Unique identifier of the custom field
Level of the custom field
Available options:
TERM, CONCEPT Example:
"TERM"
Type of the custom field
Available options:
STRING, NUMBER, DATE, BOOLEAN, SINGLE_SELECT, MULTI_SELECT, URL Example:
"SINGLE_SELECT"
List of possible values for select type fields
Was this page helpful?