System API can perform functions to interact or exchange data that is present in Joget General Settings.
| Name | Description |
|---|
| 1 | |
Get all settings and its values by default. Able to filter or sort the returned results via parameters.
Name | Description |
|---|
| URL | /system/find | | HTTP Method | GET | | Query String Parameters | | Parameter | Description |
|---|
| propertyFilter | Filters 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. | | startOffset | Starting position of records to start query. Expects an integer. | | pageSize | Number of results to return. Expects an integer. |
| | Sample Response |
[
{
"property": "css",
"value": ""
},
{
"property": "smtpPort",
"value": ""
},
{
"property": "criticalWarningLevel",
"value": ""
},
.....
]
|
|
| 2 | |
Get the value of a setting.
Name | Description |
|---|
| URL | /system/{property} | | HTTP Method | GET | | Path Parameters | | Parameter | Description |
|---|
| property | Property ID. |
| | Sample Response |
{
"property": "defaultUserview",
"value": "appcenter/v"
}
|
|
| 3 | |
Update the value of a setting.
Name | Description |
|---|
| URL | /system | | HTTP Method | PUT | | Body Parameters | | Parameter | Description |
|---|
| property | Property ID. | | value | Property value. |
| | Sample Response |
{
"property": "disablePerformanceAnalyzer",
"value": "true"
}
|
|