You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 10 Next »

Definition

App API can perform many app-level functions.

The options here is based on the current app context.


NameDescription
1Add environment variable

Add a new environment variable to the current app.

URL
/app/environment
Request Body ParametersDescription
idEnvironment variable ID
valueEnvironment variable value
remarksDescription of environment variable
Expected Response
{
  "id": "string",
  "value": "string",
  "remarks": "string"
}
2Create new version

Create a new app version of the current app.


3Delete environment variable

Remove the specified environment variable in the current app.

4Delete versionRemove the specified app version in context of the current app.
5Deploy XPDLDeploy a XPDL file as a new/updated process design to the current app.
6Download XPDLDownload the specified process definition as a XPDL file into the current machine.
7Download addon builder definitionDownload the specified addon builder JSON definition.
8Download datalist definitionDownload the specified datalist JSON definition.
9Download form definitionDownload the specified form JSON definition.
10Download userview definitionDownload the specified userview JSON definition.
11Find environment variableGet values of all environment variable(s) in the current app by default. Able to filter or sort the returned results via parameters.
12Get environment variable by IDGet values of an environment variable by its specified ID.
13Increase environment variable counter valueIncrements the specified environment variable counter value by 1.
14List created addon builder elementList ID of all created addon builder element(s) present in the current app.
15List created datalistList ID of all created datalist(s) present in the current app.
16List created formList ID of all created form(s) present in the current app.
17List created userviewList ID of all created userview(s) present in the current app.
18List versionsList ID of all created app version(s) of the current app.
19Published versionGet the currently published app version of the current app.
20Retrieve created addon builder element as optionsList label & value of all addon builder element(s) present in the current app.
21Retrieve created datalist as optionsList label & value of all datalist(s) present in the current app.
22Retrieve created form as optionsList label & value of all form(s) present in the current app.
23Retrieve created userview as optionsList label & value of all userview(s) present in the current app.
24Retrieve processes as optionsList label & value of all process(es) present in the current app.
25Update environment variableUpdate the value of an environment variable in the current app.




  • No labels