Set Pref Value
Sets the preference value for specific section + key.
Calls the Preference agent service SetPreference or SetPreferenceEntity.
Headers
The application token that identifies the partner app. Used when calling Online WebAPI from a server.
Path Parameters
The name of the preference section.
The name of the preference key.
Body
The preference definition
One preference item, which contains a specification (section/key), the raw string value, and the level at which this value was found. Carrier object for Preference. Services for the Preference Carrier is available from the Preference Agent.
Preference level, using the standard enumerated type. Undefined is returned for preferences that do not have a current setting.
Undefined, HardDefault, SystemWide, Database, Group, Individual, PC Preference value
Preference specification, consisting of the section name and key name Carrier object for PreferenceSpec. Services for the PreferenceSpec Carrier is available from the Preference Agent.
Display value, populated when asked for. Suitable for binding display-datasource in lists, etc. Formatted using CultureDataFormatter.
Display tooltip, populated when asked for. Suitable for binding display-datasource in lists, etc. Formatted using CultureDataFormatter.
Display type, populated when asked for.
Unknown, Number, Text, Bool, ListOfValues, ListTableRef, TimeList, ContactID, PersonID, ProjectID, SelectionID, PosSize, TimeZone, Time, Password, MultiLineText Carrier object for TabOrder. Services for the TabOrder Carrier is available from the Preference Agent.
The id of the target row. The table it points at is specified by the preference type.
The id of the prefdesc this preference is connected to
For DisplayType=PrefDescValueType.ListTableRef, TableName will contain the name of the table which the value reference to.
The id of the user preference
Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.
Field property dictionary mapping field names to field access rights.
Response
No Content
Related topics
Set Pref Value_ P O S TSet Pref Value At LevelSet Pref Value At Level_ P O S TNSPreferenceDescriptionLineSet History Length Pref ValueSet Xsrf Value