System API

Introduction

The System API lets you interact with Joget's General Settings configuration values. You can retrieve, update, and filter system settings using this API.

Get started

Where to get the plugin

The System API is part of the Joget platform and is available by default. No additional plugin installation is required.

How to install

The System API is built into the Joget platform. No installation steps are necessary.

How to use it

Drag and drop the System API from the Palette to the Canvas.
Select the endpoints

List of API Endpoints

Find setting

Get all settings and its values by default.

Able to filter or sort the returned results via parameters.

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. Expect a boolean value. Must be used in conjunction with sort parameter.
`startOffset`	Starting position of records to start query. Expect an integer.
`pageSize`	Number of results to return. Expect an integer.

Sample Response

[
  {
    "property": "css",
    "value": ""
  },
  {
    "property": "smtpPort",
    "value": ""
  },
  {
    "property": "criticalWarningLevel",
    "value": ""
  },
    .....
]

Get setting

Get the value of a setting.

URL: /system/{property}

HTTP Method: GET

Path Parameters

Parameter	Description
`property`	Property ID.

Sample Response

{
  "property": "defaultUserview",
  "value": "appcenter/v"
}

Update setting

Update the value of a setting.

URL: /system

HTTP Method: PUT

Body Parameters

Parameter	Description
`property`	Property ID.
`value`	Property value.

Sample Response

{
  "property": "disablePerformanceAnalyzer",
  "value": "true"
}

Created by Julieth Last modified by Aadrian on Dec 03, 2024

Tags:

Previous SSO API NextUser API