Save User Defined Field Infos
using RestSharp;
var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/UserDefinedFieldInfo/SaveUserDefinedFieldInfos");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n \"Infos\": [\n {\n \"UDefFieldId\": 123,\n \"ColumnId\": 123,\n \"FieldDefault\": \"<string>\",\n \"FieldHeight\": 123,\n \"FieldLabel\": \"<string>\",\n \"FieldLeft\": 123,\n \"FieldTop\": 123,\n \"FieldWidth\": 123,\n \"FormatMask\": \"<string>\",\n \"HideLabel\": true,\n \"IsIndexed\": true,\n \"LabelHeight\": 123,\n \"LabelLeft\": 123,\n \"LabelTop\": 123,\n \"LabelWidth\": 123,\n \"LastVersionId\": 123,\n \"ListTableId\": 123,\n \"IsMandatory\": true,\n \"Page1LineNo\": 123,\n \"ProgId\": \"<string>\",\n \"IsReadOnly\": true,\n \"ShortLabel\": \"<string>\",\n \"TabOrder\": 123,\n \"TextLength\": 123,\n \"Tooltip\": \"<string>\",\n \"UdefIdentity\": 123,\n \"UDListDefinitionId\": 123,\n \"Version\": 123,\n \"TemplateVariableName\": \"<string>\",\n \"HasBeenPublished\": true,\n \"MdoListName\": \"<string>\",\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n }\n ]\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
Infos: [
{
UDefFieldId: 123,
ColumnId: 123,
FieldDefault: '<string>',
FieldHeight: 123,
FieldLabel: '<string>',
FieldLeft: 123,
FieldTop: 123,
FieldWidth: 123,
FormatMask: '<string>',
HideLabel: true,
IsIndexed: true,
LabelHeight: 123,
LabelLeft: 123,
LabelTop: 123,
LabelWidth: 123,
LastVersionId: 123,
ListTableId: 123,
IsMandatory: true,
Page1LineNo: 123,
ProgId: '<string>',
IsReadOnly: true,
ShortLabel: '<string>',
TabOrder: 123,
TextLength: 123,
Tooltip: '<string>',
UdefIdentity: 123,
UDListDefinitionId: 123,
Version: 123,
TemplateVariableName: '<string>',
HasBeenPublished: true,
MdoListName: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
]
})
};
fetch('http://localhost:56350/api/v1/Agents/UserDefinedFieldInfo/SaveUserDefinedFieldInfos', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "56350",
CURLOPT_URL => "http://localhost:56350/api/v1/Agents/UserDefinedFieldInfo/SaveUserDefinedFieldInfos",
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([
'Infos' => [
[
'UDefFieldId' => 123,
'ColumnId' => 123,
'FieldDefault' => '<string>',
'FieldHeight' => 123,
'FieldLabel' => '<string>',
'FieldLeft' => 123,
'FieldTop' => 123,
'FieldWidth' => 123,
'FormatMask' => '<string>',
'HideLabel' => true,
'IsIndexed' => true,
'LabelHeight' => 123,
'LabelLeft' => 123,
'LabelTop' => 123,
'LabelWidth' => 123,
'LastVersionId' => 123,
'ListTableId' => 123,
'IsMandatory' => true,
'Page1LineNo' => 123,
'ProgId' => '<string>',
'IsReadOnly' => true,
'ShortLabel' => '<string>',
'TabOrder' => 123,
'TextLength' => 123,
'Tooltip' => '<string>',
'UdefIdentity' => 123,
'UDListDefinitionId' => 123,
'Version' => 123,
'TemplateVariableName' => '<string>',
'HasBeenPublished' => true,
'MdoListName' => '<string>',
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}import requests
url = "http://localhost:56350/api/v1/Agents/UserDefinedFieldInfo/SaveUserDefinedFieldInfos"
payload = { "Infos": [
{
"UDefFieldId": 123,
"ColumnId": 123,
"FieldDefault": "<string>",
"FieldHeight": 123,
"FieldLabel": "<string>",
"FieldLeft": 123,
"FieldTop": 123,
"FieldWidth": 123,
"FormatMask": "<string>",
"HideLabel": True,
"IsIndexed": True,
"LabelHeight": 123,
"LabelLeft": 123,
"LabelTop": 123,
"LabelWidth": 123,
"LastVersionId": 123,
"ListTableId": 123,
"IsMandatory": True,
"Page1LineNo": 123,
"ProgId": "<string>",
"IsReadOnly": True,
"ShortLabel": "<string>",
"TabOrder": 123,
"TextLength": 123,
"Tooltip": "<string>",
"UdefIdentity": 123,
"UDListDefinitionId": 123,
"Version": 123,
"TemplateVariableName": "<string>",
"HasBeenPublished": True,
"MdoListName": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
] }
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
Infos: [
{
UDefFieldId: 123,
ColumnId: 123,
FieldDefault: '<string>',
FieldHeight: 123,
FieldLabel: '<string>',
FieldLeft: 123,
FieldTop: 123,
FieldWidth: 123,
FormatMask: '<string>',
HideLabel: true,
IsIndexed: true,
LabelHeight: 123,
LabelLeft: 123,
LabelTop: 123,
LabelWidth: 123,
LastVersionId: 123,
ListTableId: 123,
IsMandatory: true,
Page1LineNo: 123,
ProgId: '<string>',
IsReadOnly: true,
ShortLabel: '<string>',
TabOrder: 123,
TextLength: 123,
Tooltip: '<string>',
UdefIdentity: 123,
UDListDefinitionId: 123,
Version: 123,
TemplateVariableName: '<string>',
HasBeenPublished: true,
MdoListName: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
]
})
};
fetch('http://localhost:56350/api/v1/Agents/UserDefinedFieldInfo/SaveUserDefinedFieldInfos', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));Save User Defined Field Infos
Save an array of user defined fields.
This will update the unpublished layout. NsApiSlow threshold: 5000 ms.
Save User Defined Field Infos
using RestSharp;
var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/UserDefinedFieldInfo/SaveUserDefinedFieldInfos");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n \"Infos\": [\n {\n \"UDefFieldId\": 123,\n \"ColumnId\": 123,\n \"FieldDefault\": \"<string>\",\n \"FieldHeight\": 123,\n \"FieldLabel\": \"<string>\",\n \"FieldLeft\": 123,\n \"FieldTop\": 123,\n \"FieldWidth\": 123,\n \"FormatMask\": \"<string>\",\n \"HideLabel\": true,\n \"IsIndexed\": true,\n \"LabelHeight\": 123,\n \"LabelLeft\": 123,\n \"LabelTop\": 123,\n \"LabelWidth\": 123,\n \"LastVersionId\": 123,\n \"ListTableId\": 123,\n \"IsMandatory\": true,\n \"Page1LineNo\": 123,\n \"ProgId\": \"<string>\",\n \"IsReadOnly\": true,\n \"ShortLabel\": \"<string>\",\n \"TabOrder\": 123,\n \"TextLength\": 123,\n \"Tooltip\": \"<string>\",\n \"UdefIdentity\": 123,\n \"UDListDefinitionId\": 123,\n \"Version\": 123,\n \"TemplateVariableName\": \"<string>\",\n \"HasBeenPublished\": true,\n \"MdoListName\": \"<string>\",\n \"TableRight\": {\n \"Mask\": \"<string>\",\n \"Reason\": \"<string>\"\n },\n \"FieldProperties\": {}\n }\n ]\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
Infos: [
{
UDefFieldId: 123,
ColumnId: 123,
FieldDefault: '<string>',
FieldHeight: 123,
FieldLabel: '<string>',
FieldLeft: 123,
FieldTop: 123,
FieldWidth: 123,
FormatMask: '<string>',
HideLabel: true,
IsIndexed: true,
LabelHeight: 123,
LabelLeft: 123,
LabelTop: 123,
LabelWidth: 123,
LastVersionId: 123,
ListTableId: 123,
IsMandatory: true,
Page1LineNo: 123,
ProgId: '<string>',
IsReadOnly: true,
ShortLabel: '<string>',
TabOrder: 123,
TextLength: 123,
Tooltip: '<string>',
UdefIdentity: 123,
UDListDefinitionId: 123,
Version: 123,
TemplateVariableName: '<string>',
HasBeenPublished: true,
MdoListName: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
]
})
};
fetch('http://localhost:56350/api/v1/Agents/UserDefinedFieldInfo/SaveUserDefinedFieldInfos', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "56350",
CURLOPT_URL => "http://localhost:56350/api/v1/Agents/UserDefinedFieldInfo/SaveUserDefinedFieldInfos",
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([
'Infos' => [
[
'UDefFieldId' => 123,
'ColumnId' => 123,
'FieldDefault' => '<string>',
'FieldHeight' => 123,
'FieldLabel' => '<string>',
'FieldLeft' => 123,
'FieldTop' => 123,
'FieldWidth' => 123,
'FormatMask' => '<string>',
'HideLabel' => true,
'IsIndexed' => true,
'LabelHeight' => 123,
'LabelLeft' => 123,
'LabelTop' => 123,
'LabelWidth' => 123,
'LastVersionId' => 123,
'ListTableId' => 123,
'IsMandatory' => true,
'Page1LineNo' => 123,
'ProgId' => '<string>',
'IsReadOnly' => true,
'ShortLabel' => '<string>',
'TabOrder' => 123,
'TextLength' => 123,
'Tooltip' => '<string>',
'UdefIdentity' => 123,
'UDListDefinitionId' => 123,
'Version' => 123,
'TemplateVariableName' => '<string>',
'HasBeenPublished' => true,
'MdoListName' => '<string>',
'TableRight' => [
'Mask' => '<string>',
'Reason' => '<string>'
],
'FieldProperties' => [
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}import requests
url = "http://localhost:56350/api/v1/Agents/UserDefinedFieldInfo/SaveUserDefinedFieldInfos"
payload = { "Infos": [
{
"UDefFieldId": 123,
"ColumnId": 123,
"FieldDefault": "<string>",
"FieldHeight": 123,
"FieldLabel": "<string>",
"FieldLeft": 123,
"FieldTop": 123,
"FieldWidth": 123,
"FormatMask": "<string>",
"HideLabel": True,
"IsIndexed": True,
"LabelHeight": 123,
"LabelLeft": 123,
"LabelTop": 123,
"LabelWidth": 123,
"LastVersionId": 123,
"ListTableId": 123,
"IsMandatory": True,
"Page1LineNo": 123,
"ProgId": "<string>",
"IsReadOnly": True,
"ShortLabel": "<string>",
"TabOrder": 123,
"TextLength": 123,
"Tooltip": "<string>",
"UdefIdentity": 123,
"UDListDefinitionId": 123,
"Version": 123,
"TemplateVariableName": "<string>",
"HasBeenPublished": True,
"MdoListName": "<string>",
"TableRight": {
"Mask": "<string>",
"Reason": "<string>"
},
"FieldProperties": {}
}
] }
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
Infos: [
{
UDefFieldId: 123,
ColumnId: 123,
FieldDefault: '<string>',
FieldHeight: 123,
FieldLabel: '<string>',
FieldLeft: 123,
FieldTop: 123,
FieldWidth: 123,
FormatMask: '<string>',
HideLabel: true,
IsIndexed: true,
LabelHeight: 123,
LabelLeft: 123,
LabelTop: 123,
LabelWidth: 123,
LastVersionId: 123,
ListTableId: 123,
IsMandatory: true,
Page1LineNo: 123,
ProgId: '<string>',
IsReadOnly: true,
ShortLabel: '<string>',
TabOrder: 123,
TextLength: 123,
Tooltip: '<string>',
UdefIdentity: 123,
UDListDefinitionId: 123,
Version: 123,
TemplateVariableName: '<string>',
HasBeenPublished: true,
MdoListName: '<string>',
TableRight: {Mask: '<string>', Reason: '<string>'},
FieldProperties: {}
}
]
})
};
fetch('http://localhost:56350/api/v1/Agents/UserDefinedFieldInfo/SaveUserDefinedFieldInfos', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));Headers
The application token that identifies the partner app. Used when calling Online WebAPI from a server.
Query Parameters
Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.
Body
application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencodedapplication/json-patch+jsonapplication/merge-patch+json
Infos
SaveUserDefinedFieldInfos: Save an array of user defined fields. This will update the unpublished layout.
Show child attributes
Show child attributes
Response
204
No Content
Related topics
Save User Defined Field InfoNSUserDefinedFieldInfoAgentHow to create a user-defined field using the web services APIHow to update a user-defined field using the web services APIEdit user-defined fieldDelete User Defined Field Info⌘I