Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...


NameDescription
1Find Setting
Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

Get all settings and its values by default.

Able to filter or sort the returned results via parameters.

Name

Description
URL/system/find
HTTP MethodGET
Query String Parameters
ParameterDescription
propertyFilterFilters the response via property ID.
sort

Settings data column to sort.

Must be used in conjunction with "sortDescending" parameter.

sortDescending

Sort the specified "sort" parameter value in ascending or descending order.

Expects a boolean value.

Must be used in conjunction with "sort" parameter.

startOffsetStarting position of records to start query. Expects an integer.
pageSizeNumber of results to return. Expects an integer.
Sample Response
Code Block
languagejs
[
  {
    "property": "css",
    "value": ""
  },
  {
    "property": "smtpPort",
    "value": ""
  },
  {
    "property": "criticalWarningLevel",
    "value": ""
  },
	.....
]
2Get Setting
Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

Get the value (s) of a setting.

3Update Setting
Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

Update the value (s) of a setting.