System

This page details the System endpoints and the actions they support. It provides sample URLs and results for quick reference, along with further instructions on how to use each endpoint.

web/json/apps/verify

Verifies a URL is valid.

• User Role: Admin
• Method: HTTP HEAD
• Parameters: 
  • callback - (Optional) a function (in JavaScript) to call back after invoking this method
  • url - URL to test
  • Sample URL: http://localhost:8080/jw/web/json/apps/verify?url=http%3A%2F%2Fwww.joget.org

web/json/console/setting/message/list

Retrieves all messages added in Platform Translation. 

• User Role: Admin
• Method: HTTP GET/POST
• Parameters: 
  • callback - (Optional) a function (in JavaScript) to call back after invoking this method
  • filter - (Optional) string to filter the results
  • locale - (Optional) language code to filter the results
  • sort - (Optional) column name to be sorted
  • desc - (Optional) Boolean value to determine whether to sort by ascending or descending order (true equals to descending)
  • start - (Optional) where rows start from
  • rows - (Optional) number of rows per page
• Sample URL: http://localhost:8080/jw/web/json/console/setting/message/list
• Sample Result: 

{"total":1,"data":{"message":"搜索","id":"402880824fb19a77014fb5025ed80002","locale":"zh_CN","key":"general.method.label.search"}}

web/json/hash/options

Retrieves all available Hash Variable syntax.

• User Role: Admin
• Method: HTTP GET/POST
• Sample URL: http://localhost:8080/jw/web/json/hash/options
• Sample Result:

["assignment.activityDefId", "assignment.activityId", "assignment.activityName", "assignment.assigneeId", "assignment.processDefId", "assignment.processId",
"assignment.processName", "assignment.processRequesterId", "assignment.processVersion", "currentUser.active", "currentUser.email", "currentUser.firstName",
"currentUser.lastName", "currentUser.timeZone", "currentUser.username", "date.DAY+INTEGER.FORMAT", "date.DAY-INTEGER.FORMAT", "date.FORMAT", "date.MONTH+INTEGER.FORMAT",
"date.MONTH-INTEGER.FORMAT", "date.YEAR+INTEGER.FORMAT", "date.YEAR-INTEGER.FORMAT", "envVariable.KEY", "form.TABLE.COLUMN", "form.TABLE.COLUMN[PRIMARY_KEY]", "i18n.KEY",
"performer.ACTIVITY_DEF_ID.active", "performer.ACTIVITY_DEF_ID.email", "performer.ACTIVITY_DEF_ID.firstName", "performer.ACTIVITY_DEF_ID.id", "performer.ACTIVITY_DEF_ID.lastName",
"performer.ACTIVITY_DEF_ID.timeZone", "performer.ACTIVITY_DEF_ID.username", "request.characterEncoding", "request.contextPath", "request.header.NAME", "request.locale",
"request.method", "request.pathInfo", "request.protocol", "request.queryString", "request.remoteAddr", "request.requestURI", "request.requestURL", "request.requestedSessionId",
"request.scheme", "request.serverName", "request.serverPort", "request.servletPath", "requestParam.KEY", "user.USERNAME.active", "user.USERNAME.email", "user.USERNAME.firstName",
"user.USERNAME.lastName", "user.USERNAME.timeZone", "variable.KEY"]

web/json/workflow/testConnection

To tests a JDBC connection.

• User Role: Admin
• Method: HTTP GET/POST
• Parameters: 
  • datasource - Profile name. Not used.
  • driver - driver name 
  • url - connection URL
  • user - username
  • password - password
  • callback - (Optional) a function (in JavaScript) to call back after invoking this method
• Sample URL: http://localhost:8080/jw/web/json/workflow/testConnection?datasource=default&driver=com.mysql.jdbc.Driver&url=jdbc%3Amysql%3A%2F%2Flocalhost%3A3306%2Fjwdb%3FcharacterEncoding%3DUTF-8&user=root&password=
• Sample Result: 

{"success":true,"datasource":"default"}