Update Field Metadata
1 min
PATCH
https://api.nue.io/metadata/objects/{objectApiName}/fields/{fieldApiName}
Path Parameters
- objectApiNamestringrequiredExampleDescription
- fieldApiNamestringrequiredExampleDescription
Body Parameters
- bodyUpdateFieldRequestrequiredDescription
- namestringMin Length0Max Length220
- descriptionstring
- creatableboolean
- updatableboolean
- filterableboolean
- sortableboolean
- encryptedboolean
- inlineHelpTextstring
- requiredboolean
- uniqueboolean
- lengthinteger<int32>Formatint32
- valueSetstring
- precisioninteger<int32>Formatint32
- scaleinteger<int32>Formatint32
- autoNumberSettingAutoNumberSettingExample
{ "displayFormat": "CUSTOM-INV-{00000000}", "startValue": 1 }Description- displayFormatstringExampleDescription
- startValueinteger<int64>ExampleDescriptionFormatint64Minimum1Maximum999999999999
Responses
default
- CreateFieldResponse
- namestring
curl
curl --request PATCH \
--url https://api.nue.io/metadata/objects/{objectApiName}/fields/{fieldApiName} \
--header 'accept: application/json'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var requestOptions = {
method: 'PATCH',
headers: myHeaders,
redirect: 'follow'
};
fetch("https://api.nue.io/metadata/objects/{objectApiName}/fields/{fieldApiName}", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "json"
require "net/http"
url = URI("https://api.nue.io/metadata/objects/{objectApiName}/fields/{fieldApiName}")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://api.nue.io/metadata/objects/{objectApiName}/fields/{fieldApiName}"
payload = {}
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("PATCH", url, headers=headers, data=payload)
print(response.text)
default
// default response
{
"name": ""
}GENERATED
// default response
{
"name": ""
}Update Field Metadata Response
{
"name": "name"
}