Joget DX Available for Download

Check out Joget DX, the next generation successor to Joget Workflow for faster, simpler digital transformation.

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Panel
borderColorgreen
borderWidth1
titleBGColor#ddffcc
borderStylesolid
titleDefinition

System API can perform functions to interact or exchange data that is present interact with configuration values in Joget General Settings.

...


NameDescription
1

Anchor
Find Setting
Find Setting
Find 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": ""
  },
	.....
]
2

Anchor
Get Setting
Get Setting
Get Setting

Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

Get the value of a setting.

Name

Description
URL/system/{property}
HTTP MethodGET
Path Parameters
ParameterDescription
propertyProperty ID.
Sample Response
Code Block
languagejs
{
  "property": "defaultUserview",
  "value": "appcenter/v"
}
3

Anchor
Update Setting
Update Setting
Update Setting

Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

Update the value of a setting.

Name

Description
URL/system
HTTP MethodPUT
Body Parameters
ParameterDescription
propertyProperty ID.
valueProperty value.
Sample Response
Code Block
languagejs
{
  "property": "disablePerformanceAnalyzer",
  "value": "true"
}