Page History

...

Name

Description

1

Anchor

	Add environment variable
	Add environment variable

Add environment variable

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

Add a new environment variable to the current app.

Name

Description

URL

/app/environment

HTTP Method

POST

Body Parameters

Parameter	Description
id	Environment variable ID.
value	Environment variable value.
remarks	Description of environment variable.

Sample Response

Code Block

language	js

{
  "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

borderColor	black
bgColor	#fbfff5
borderStyle	solid

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

Name

Description

URL

/app/new/{version}

HTTP Method

POST

Path Parameters

Parameter	Description
version	Version of current app to base on. Expects an integer value.

Sample Response

Code Block

language	js

{
  "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"
}

3

Delete environment variable

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

Delete the specified environment variable in the current app.

Name

Description

URL

/app/environment/{id}

HTTP Method

DELETE

Path Parameters

Parameter	Description
id	ID of environment variable to remove. Expects a string.

Sample Response

Code Block

language	js

{
  "date": "Mon Aug 26 16:57:53 SGT 2019",
  "code": "200",
  "message": "Successful operation"
}

4

Delete version

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

Delete the specified app version of the current app.

Name

Description

URL

/app/delete/{version}

HTTP Method

DELETE

Path Parameters

Parameter	Description
version	Version of current app to remove. Expects an integer value.

Sample Response

Code Block

language	js

{
  "date": "Mon Aug 26 17:02:35 SGT 2019",
  "code": "200",
  "message": "Successful operation"
}

5

Deploy XPDL

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

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

Name

Description

URL

/app/deploy/xpdl

HTTP Method

POST

Body Parameters

Parameter	Description
File	Expects a XPDL file.

Sample Response

Code Block

language	js

{
  "date": "Mon Aug 26 18:17:30 SGT 2019",
  "code": "200",
  "message": "Successful operation"
}

6

Download XPDL

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

Download the process definition of all process(es) as XPDL file.

Name	Description
URL	/app/xpdl
HTTP Method	GET
Parameters	-
Sample Response	Definition of all process(es) as XPDL.

7

Download addon builder definition

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

Download the specified addon builder page JSON definition.

Name

Description

URL

/app/{builder}/definition/{id}

HTTP Method

GET

Path Parameters

Parameter	Description
builder	Builder's ID. (e.g: "designapi" for API Builder)
id	Builder page's ID.

Sample Response

JSON definition of the builder's page.

8

Download datalist definition

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

Download the specified datalist JSON definition.

Name

Description

URL

/app/datalist/definition/{id}

HTTP Method

GET

Path Parameters

Parameter	Description
id	Datalist ID.

Sample Response

JSON definition of the Datalist.

9

Download form definition

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

Download the specified form JSON definition.

Name

Description

URL

/app/form/definition/{id}

HTTP Method

GET

Path Parameters

Parameter	Description
id	Form ID.

Sample Response

JSON definition of the Form.

10

Download userview definition

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

Download the specified userview JSON definition.

Name

Description

URL

/app/userview/definition/{id}

HTTP Method

GET

Path Parameters

Parameter	Description
id	Userview ID.

Sample Response

JSON definition of the Userview.

11

Find environment variable

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

Get values of all environment variable(s) in the current app by default.

Able to filter or sort the returned results via parameters.

Name

Description

URL

/app/environment/find

HTTP Method

GET

Query String Parameters

Parameter	Description
nameFilter	Environment variable ID.
sort	Environment variable column to sort. Must be used in conjunction with "sortDescending" parameter.
sortDescending	Sort the specified "sort" parameter value in ascending or descending order. Expects a boolean value. Must be used in conjunction with "sort" parameter.
startOffset	Starting position of records to start query. Expects an integer.
pageSize	Number of results to return. Expects an integer.

Sample Response

Code Block

language	js

[
  {
    "value": "Expenses Claim",
    "remarks": null,
    "id": "AppName"
  },
  {
    "value": "4",
    "remarks": null,
    "id": "counter"
  },
  {
    "value": "8",
    "remarks": "string",
    "id": "string"
  }
]

12

Get environment variable by ID

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

Get values of an environment variable by its specified ID.

Name

Description

URL

/app/environment/{id}

HTTP Method

GET

Path Parameters

Parameter	Description
id	Environment variable ID.

Sample Response

Code Block

language	js

{
  "value": "Expenses Claim",
  "remarks": null,
  "id": "AppName"
}

13

Increase environment variable counter value

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

Increments the specified environment variable counter value by 1.

Name

Description

URL

/app/environment/increaseCounter

HTTP Method

PUT

Path Body Parameters

Parameter	Description
id	Environment variable ID with a number value only.

Sample Response

Code Block

language	js

{
  "value": "6",
  "remarks": null,
  "id": "counter"
}

14

List created addon builder element

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

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

Name

Description

URL

/app/list/{builder}

HTTP Method

GET

Path Parameters

Parameter	Description
builder	Builder's ID. (e.g: "api" for API Builder)

Query String Parameters

Parameter	Description
nameFilter	Builder page ID.
sort	Builder data column to sort. Must be used in conjunction with "sortDescending" parameter.
sortDescending	Sort the specified "sort" parameter value in ascending or descending order. Expects a boolean value. Must be used in conjunction with "sort" parameter.
startOffset	Starting position of records to start query. Expects an integer.
pageSize	Number of results to return. Expects an integer.

Sample Response

Code Block

language	js

[
  {
    "name": null,
    "type": "api",
    "description": null,
    "dateCreated": null,
    "dateModified": null,
    "id": "API-c12135da-a5f6-41c4-ba99-bfaa16bbe636"
  },
  {
    "name": null,
    "type": "api",
    "description": null,
    "dateCreated": null,
    "dateModified": null,
    "id": "API-5bc8e093-00cd-455a-a6b0-d94aa92a446f"
  }
]

15

List created datalist

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

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

Name

Description

URL

/app/list/datalist

HTTP Method

GET

Path Query String Parameters

Parameter	Description
nameFilter	Datalist ID.
sort	Datalist data column to sort. Must be used in conjunction with "sortDescending" parameter.
sortDescending	Sort the specified "sort" parameter value in ascending or descending order. Expects a boolean value. Must be used in conjunction with "sort" parameter.
startOffset	Starting position of records to start query. Expects an integer.
pageSize	Number of results to return. Expects an integer.

Sample Response

Code Block

language	js

[
  {
    "name": null,
    "description": null,
    "dateCreated": null,
    "dateModified": null,
    "id": "ExpensesListAll"
  },
  {
    "name": null,
    "description": null,
    "dateCreated": null,
    "dateModified": null,
    "id": "ExpensesApproved"
  },
	.....
]

16

List created form

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

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

Name

Description

URL

/app/list/form

HTTP Method

GET

Path Query String Parameters

Parameter	Description
nameFilter	Form ID.
sort	Form data column to sort. Must be used in conjunction with "sortDescending" parameter.
sortDescending	Sort the specified "sort" parameter value in ascending or descending order. Expects a boolean value. Must be used in conjunction with "sort" parameter.
startOffset	Starting position of records to start query. Expects an integer.
pageSize	Number of results to return. Expects an integer.

Sample Response

Code Block

language	js

[
  {
    "name": null,
    "tableName": "j_expense_claim",
    "description": null,
    "dateCreated": null,
    "dateModified": null,
    "id": "ExpensesApprovalDetail"
  },
  {
    "name": null,
    "tableName": "j_expense_approval",
    "description": null,
    "dateCreated": null,
    "dateModified": null,
    "id": "ExpensesApprovalEntry"
  },
	.....
]

17

List created userview

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

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

Name

Description

URL

/app/list/userview

HTTP Method

GET

Path Query String Parameters

Parameter	Description
nameFilter	Userview ID.
sort	Userview data column to sort. Must be used in conjunction with "sortDescending" parameter.
sortDescending	Sort the specified "sort" parameter value in ascending or descending order. Expects a boolean value. Must be used in conjunction with "sort" parameter.
startOffset	Starting position of records to start query. Expects an integer.
pageSize	Number of results to return. Expects an integer.

Sample Response

Code Block

language	js

[
  {
    "name": null,
    "description": null,
    "dateCreated": null,
    "dateModified": null,
    "thumbnail": null,
    "id": "home"
  },
  {
    "name": null,
    "description": null,
    "dateCreated": null,
    "dateModified": null,
    "thumbnail": null,
    "id": "dashboard"
  }
]

18

List versions

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

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

Name

Description

URL

/app/versions

HTTP Method

GET

Path Query String Parameters

Parameter	Description
sort	App version data column to sort. Must be used in conjunction with "sortDescending" parameter.
sortDescending	Sort the specified "sort" parameter value in ascending or descending order. Expects a boolean value. Must be used in conjunction with "sort" parameter.
startOffset	Starting position of records to start query. Expects an integer.
pageSize	Number of results to return. Expects an integer.

Sample Response

Code Block

language	js

[
  {
    "published": true,
    "description": null,
    "meta": null,
    "id": "expenseclaim",
    "version": 1,
    "name": "Expenses Claim",
    "dateCreated": "Nov 14, 2018 2:20:33 PM",
    "dateModified": "Aug 26, 2019 7:29:43 PM"
  }
]

19

Published version

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

Get the currently published app version of the current app.

Name

Description

URL

/app/published

HTTP Method

GET

Path Parameters

Parameter	Description

Sample Response

Code Block

language	js

20

Retrieve created addon builder element as options

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

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

Name

Description

URL

/app/{builder}/options

HTTP Method

GET

Path Parameters

Parameter	Description

Sample Response

Code Block

language	js

21

Retrieve created datalist as options

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

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

Name

Description

URL

/app/datalist/options

HTTP Method

GET

Path Parameters

Parameter	Description

Sample Response

Code Block

language	js

22

Retrieve created form as options

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

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

Name

Description

URL

/app/form/options

HTTP Method

GET

Path Parameters

Parameter	Description

Sample Response

Code Block

language	js

23

Retrieve created userview as options

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

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

Name

Description

URL

/app/userview/options

HTTP Method

GET

Path Parameters

Parameter	Description

Sample Response

Code Block

language	js

24

Retrieve processes as options

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

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

Name

Description

URL

/app/process/options

HTTP Method

GET

Path Parameters

Parameter	Description

Sample Response

Code Block

language	js

25

Update environment variable

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

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

Name

Description

URL

/app/environment

HTTP Method

PUT

Path Parameters

Parameter	Description

Sample Response

Code Block

language	js

...

Space shortcuts

Page tree

Versions Compared

Old Version 40

New Version 41

Key