Joget DX Available for Download

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

Skip to end of metadata
Go to start of metadata
Definition

System API can interact with configuration values in Joget General Settings.


NameDescription
1

Find Setting

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
[
  {
    "property": "css",
    "value": ""
  },
  {
    "property": "smtpPort",
    "value": ""
  },
  {
    "property": "criticalWarningLevel",
    "value": ""
  },
	.....
]
2

Get Setting

Get the value of a setting.

Name

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

Update Setting

Update the value of a setting.

Name

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




  • No labels