App API can perform many app-level functions.

The options here is based on the current app context.


NameDescription
1

Add environment variable

Add a new environment variable to the current app.

Name

Description
URL/app/environment
HTTP MethodPOST
Request Body Parameters
ParameterDescription
idEnvironment variable ID
valueEnvironment variable value
remarksDescription of environment variable
Response Schema
{
  "id": "string",
  "value": "string",
  "remarks": "string"
}
2

Create new version

Create a new app version of the current app.

Name

Description
URL/app/new/{version}
HTTP MethodPOST
Request Body Parameters
ParameterDescription
idEnvironment variable ID
valueEnvironment variable value
remarksDescription of environment variable
Response Schema
{
  "id": "string",
  "value": "string",
  "remarks": "string"
}
3Delete environment variable

Remove the specified environment variable in the current app.

/app/environment/{id}
DELETE
4Delete version

Remove the specified app version in context of the current app.

/app/delete/{version}
DELETE
5Deploy XPDL

Deploy a XPDL file as a new/updated process design to the current app.

/app/deploy/xpdl
POST
6Download XPDL

Download the specified process definition as a XPDL file into the current machine.

/app/xpdl
GET
7Download addon builder definition

Download the specified addon builder JSON definition.

/app/{builder}/definition/{id}
GET
8Download datalist definition

Download the specified datalist JSON definition.

/app/datalist/definition/{id}
GET
9Download form definition

Download the specified form JSON definition.

/app/form/definition/{id}
GET
10Download userview definition

Download the specified userview JSON definition.

/app/userview/definition/{id}
GET
11Find environment variable

Get values of all environment variable(s) in the current app by default. Able to filter or sort the returned results via parameters.

/app/environment/find
GET
12Get environment variable by ID

Get values of an environment variable by its specified ID.

/app/environment/{id}
GET
13Increase environment variable counter value

Increments the specified environment variable counter value by 1.

/app/environment/increaseCounter
PUT
14List created addon builder element

List ID of all created addon builder element(s) present in the current app.

/app/list/{builder}
GET
15List created datalist

List ID of all created datalist(s) present in the current app.

/app/list/datalist
GET
16List created form

List ID of all created form(s) present in the current app.

/app/list/form
GET
17List created userview

List ID of all created userview(s) present in the current app.

/app/list/userview
GET
18List versions

List ID of all created app version(s) of the current app.

/app/versions
GET
19Published version

Get the currently published app version of the current app.

/app/published
GET
20Retrieve created addon builder element as options

List label & value of all addon builder element(s) present in the current app.

/app/{builder}/options
GET
21Retrieve created datalist as options

List label & value of all datalist(s) present in the current app.

/app/datalist/options
GET
22Retrieve created form as options

List label & value of all form(s) present in the current app.

/app/form/options
GET
23Retrieve created userview as options

List label & value of all userview(s) present in the current app.

/app/userview/options
GET
24Retrieve processes as options

List label & value of all process(es) present in the current app.

/app/process/options
GET
25Update environment variable

Update the value of an environment variable in the current app.

/app/environment
PUT