App API can perform many app-level functions.
The options here is based on the current app context.
| Name | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 1 | Add environment variable | Add a new environment variable to the current app. URL
/app/environment
HTTP Method
POST
Response Schema {
"id": "string",
"value": "string",
"remarks": "string"
}
| ||||||||
| 2 | Create new version | Create a new app version of the current app. URL
/app/new/{version}
HTTP Method
POST
| ||||||||
| 3 | Delete environment variable | Remove the specified environment variable in the current app. URL
/app/environment/{id}
HTTP Method
DELETE
| ||||||||
| 4 | Delete version | Remove the specified app version in context of the current app. URL
/app/delete/{version}
HTTP Method
DELETE
| ||||||||
| 5 | Deploy XPDL | Deploy a XPDL file as a new/updated process design to the current app. URL
/app/deploy/xpdl
HTTP Method
POST
| ||||||||
| 6 | Download XPDL | Download the specified process definition as a XPDL file into the current machine. URL
/app/xpdl
HTTP Method
GET
| ||||||||
| 7 | Download addon builder definition | Download the specified addon builder JSON definition. URL
/app/{builder}/definition/{id}
HTTP Method
GET
| ||||||||
| 8 | Download datalist definition | Download the specified datalist JSON definition. URL
/app/datalist/definition/{id}
HTTP Method
GET
| ||||||||
| 9 | Download form definition | Download the specified form JSON definition. URL
/app/form/definition/{id}
HTTP Method
GET
| ||||||||
| 10 | Download userview definition | Download the specified userview JSON definition. URL
/app/userview/definition/{id}
HTTP Method
GET
| ||||||||
| 11 | Find 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. URL
/app/environment/find
HTTP Method
GET
| ||||||||
| 12 | Get environment variable by ID | Get values of an environment variable by its specified ID. URL
/app/environment/{id}
HTTP Method
GET
| ||||||||
| 13 | Increase environment variable counter value | Increments the specified environment variable counter value by 1. URL
/app/environment/increaseCounter
HTTP Method
PUT
| ||||||||
| 14 | List created addon builder element | List ID of all created addon builder element(s) present in the current app. URL
/app/list/{builder}
HTTP Method
GET
| ||||||||
| 15 | List created datalist | List ID of all created datalist(s) present in the current app. URL
/app/list/datalist
HTTP Method
GET
| ||||||||
| 16 | List created form | List ID of all created form(s) present in the current app. URL
/app/list/form
HTTP Method
GET
| ||||||||
| 17 | List created userview | List ID of all created userview(s) present in the current app. URL
/app/list/userview
HTTP Method
GET
| ||||||||
| 18 | List versions | List ID of all created app version(s) of the current app. URL
/app/versions
HTTP Method
GET
| ||||||||
| 19 | Published version | Get the currently published app version of the current app. URL
/app/published
HTTP Method
GET
| ||||||||
| 20 | Retrieve created addon builder element as options | List label & value of all addon builder element(s) present in the current app. URL
/app/{builder}/options
HTTP Method
GET
| ||||||||
| 21 | Retrieve created datalist as options | List label & value of all datalist(s) present in the current app. URL
/app/datalist/options
HTTP Method
GET
| ||||||||
| 22 | Retrieve created form as options | List label & value of all form(s) present in the current app. URL
/app/form/options
HTTP Method
GET
| ||||||||
| 23 | Retrieve created userview as options | List label & value of all userview(s) present in the current app. URL
/app/userview/options
HTTP Method
GET
| ||||||||
| 24 | Retrieve processes as options | List label & value of all process(es) present in the current app. URL
/app/process/options
HTTP Method
GET
| ||||||||
| 25 | Update environment variable | Update the value of an environment variable in the current app. URL
/app/environment
HTTP Method
PUT
|