Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...


NameDescription
1

Anchor
Add environment variable
Add environment variable
Add environment variable

Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

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.
Sample Response
Code Block
languagejs
titleResponse Schema
{
  "value": "I exist via API.",
  "remarks": "This is an environment variable created with API Builder.",
  "id": "apiEnvVar"
}
2

Anchor
Create new version
Create new version
Create new version

Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

Create a new app version based on the specified version of the current app.

Name

Description
URL/app/new/{version}
HTTP MethodPOST
Path Parameters
ParameterDescription
versionVersion of current app to base on. Expects an integer value.
Sample Response
Code Block
languagejs
titleResponse Schema
{
  "published": false,
  "description": null,
  "meta": null,
  "id": "expenseclaim",
  "version": 2,
  "name": "Expenses Claim",
  "dateCreated": "Aug 26, 2019 4:37:19 PM",
  "dateModified": "Aug 26, 2019 4:37:22 PM"
}
3Delete environment variable
Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

Remove the specified environment variable in the current app.

Name

Description
URL/app/environment/{id}
HTTP MethodDELETE
Path Parameters
ParameterDescription
idID of environment variable to remove. Expects a string.
Sample Response
Code Block
languagejs
titleResponse Schema
{
  "
published
date":
false,
 "
description": null, "meta": null, "id": "expenseclaim", "version": 2
Mon Aug 26 16:57:53 SGT 2019",
  "
name
code": "
Expenses Claim
200",
  "
dateCreated
message": "
Aug 26, 2019 4:37:19 PM", "dateModified": "Aug 26, 2019 4:37:22 PM
Successful operation"
}
4Delete version

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

Panel
borderColorlightgreen
borderWidth1
titleBGColor#c4ffd8
borderStylesolid
titleURL
/app/delete/{version}
Panel
borderColor#f5c402
borderWidth1
titleBGColor#fff5cf
borderStylesolid
titleHTTP Method
DELETE
5Deploy XPDL

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

Panel
borderColorlightgreen
borderWidth1
titleBGColor#c4ffd8
borderStylesolid
titleURL
/app/deploy/xpdl
Panel
borderColor#f5c402
borderWidth1
titleBGColor#fff5cf
borderStylesolid
titleHTTP Method
POST
6Download XPDL

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

Panel
borderColorlightgreen
borderWidth1
titleBGColor#c4ffd8
borderStylesolid
titleURL
/app/xpdl
Panel
borderColor#f5c402
borderWidth1
titleBGColor#fff5cf
borderStylesolid
titleHTTP Method
GET
7Download addon builder definition

Download the specified addon builder JSON definition.

Panel
borderColorlightgreen
borderWidth1
titleBGColor#c4ffd8
borderStylesolid
titleURL
/app/{builder}/definition/{id}
Panel
borderColor#f5c402
borderWidth1
titleBGColor#fff5cf
borderStylesolid
titleHTTP Method
GET
8Download datalist definition

Download the specified datalist JSON definition.

Panel
borderColorlightgreen
borderWidth1
titleBGColor#c4ffd8
borderStylesolid
titleURL
/app/datalist/definition/{id}
Panel
borderColor#f5c402
borderWidth1
titleBGColor#fff5cf
borderStylesolid
titleHTTP Method
GET
9Download form definition

Download the specified form JSON definition.

Panel
borderColorlightgreen
borderWidth1
titleBGColor#c4ffd8
borderStylesolid
titleURL
/app/form/definition/{id}
Panel
borderColor#f5c402
borderWidth1
titleBGColor#fff5cf
borderStylesolid
titleHTTP Method
GET
10Download userview definition

Download the specified userview JSON definition.

Panel
borderColorlightgreen
borderWidth1
titleBGColor#c4ffd8
borderStylesolid
titleURL
/app/userview/definition/{id}
Panel
borderColor#f5c402
borderWidth1
titleBGColor#fff5cf
borderStylesolid
titleHTTP Method
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.

Panel
borderColorlightgreen
borderWidth1
titleBGColor#c4ffd8
borderStylesolid
titleURL
/app/environment/find
Panel
borderColor#f5c402
borderWidth1
titleBGColor#fff5cf
borderStylesolid
titleHTTP Method
GET
12Get environment variable by ID

Get values of an environment variable by its specified ID.

Panel
borderColorlightgreen
borderWidth1
titleBGColor#c4ffd8
borderStylesolid
titleURL
/app/environment/{id}
Panel
borderColor#f5c402
borderWidth1
titleBGColor#fff5cf
borderStylesolid
titleHTTP Method
GET
13Increase environment variable counter value

Increments the specified environment variable counter value by 1.

Panel
borderColorlightgreen
borderWidth1
titleBGColor#c4ffd8
borderStylesolid
titleURL
/app/environment/increaseCounter
Panel
borderColor#f5c402
borderWidth1
titleBGColor#fff5cf
borderStylesolid
titleHTTP Method
PUT
14List created addon builder element

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

Panel
borderColorlightgreen
borderWidth1
titleBGColor#c4ffd8
borderStylesolid
titleURL
/app/list/{builder}
Panel
borderColor#f5c402
borderWidth1
titleBGColor#fff5cf
borderStylesolid
titleHTTP Method
GET
15List created datalist

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

Panel
borderColorlightgreen
borderWidth1
titleBGColor#c4ffd8
borderStylesolid
titleURL
/app/list/datalist
Panel
borderColor#f5c402
borderWidth1
titleBGColor#fff5cf
borderStylesolid
titleHTTP Method
GET
16List created form

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

Panel
borderColorlightgreen
borderWidth1
titleBGColor#c4ffd8
borderStylesolid
titleURL
/app/list/form
Panel
borderColor#f5c402
borderWidth1
titleBGColor#fff5cf
borderStylesolid
titleHTTP Method
GET
17List created userview

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

Panel
borderColorlightgreen
borderWidth1
titleBGColor#c4ffd8
borderStylesolid
titleURL
/app/list/userview
Panel
borderColor#f5c402
borderWidth1
titleBGColor#fff5cf
borderStylesolid
titleHTTP Method
GET
18List versions

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

Panel
borderColorlightgreen
borderWidth1
titleBGColor#c4ffd8
borderStylesolid
titleURL
/app/versions
Panel
borderColor#f5c402
borderWidth1
titleBGColor#fff5cf
borderStylesolid
titleHTTP Method
GET
19Published version

Get the currently published app version of the current app.

Panel
borderColorlightgreen
borderWidth1
titleBGColor#c4ffd8
borderStylesolid
titleURL
/app/published
Panel
borderColor#f5c402
borderWidth1
titleBGColor#fff5cf
borderStylesolid
titleHTTP Method
GET
20Retrieve created addon builder element as options

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

Panel
borderColorlightgreen
borderWidth1
titleBGColor#c4ffd8
borderStylesolid
titleURL
/app/{builder}/options
Panel
borderColor#f5c402
borderWidth1
titleBGColor#fff5cf
borderStylesolid
titleHTTP Method
GET
21Retrieve created datalist as options

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

Panel
borderColorlightgreen
borderWidth1
titleBGColor#c4ffd8
borderStylesolid
titleURL
/app/datalist/options
Panel
borderColor#f5c402
borderWidth1
titleBGColor#fff5cf
borderStylesolid
titleHTTP Method
GET
22Retrieve created form as options

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

Panel
borderColorlightgreen
borderWidth1
titleBGColor#c4ffd8
borderStylesolid
titleURL
/app/form/options
Panel
borderColor#f5c402
borderWidth1
titleBGColor#fff5cf
borderStylesolid
titleHTTP Method
GET
23Retrieve created userview as options

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

Panel
borderColorlightgreen
borderWidth1
titleBGColor#c4ffd8
borderStylesolid
titleURL
/app/userview/options
Panel
borderColor#f5c402
borderWidth1
titleBGColor#fff5cf
borderStylesolid
titleHTTP Method
GET
24Retrieve processes as options

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

Panel
borderColorlightgreen
borderWidth1
titleBGColor#c4ffd8
borderStylesolid
titleURL
/app/process/options
Panel
borderColor#f5c402
borderWidth1
titleBGColor#fff5cf
borderStylesolid
titleHTTP Method
GET
25Update environment variable

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

Panel
borderColorlightgreen
borderWidth1
titleBGColor#c4ffd8
borderStylesolid
titleURL
/app/environment
Panel
borderColor#f5c402
borderWidth1
titleBGColor#fff5cf
borderStylesolid
titleHTTP Method
PUT

...