Page History

Panel

borderColor	green
borderWidth	1
titleBGColor	#ddffcc
borderStyle	solid
title	Definition

App API can perform many app-level functionsinteract with the app design of the current app.

Note
The options here This API is based on the current app context.

Add environment variable

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

Name

Description

1

Anchor

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.

Use "0" value to use the latest app version.

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

Anchor

	Delete environment variable
	Delete environment variable

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

Anchor

	Delete version
	Delete version

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

Anchor

	Deploy XPDL
	Deploy XPDL

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

Anchor

	Download XPDL
	Download XPDL

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	Contents of XPDL fileDefinition of all process(es) as XPDL.

7

Anchor

	Download addon builder definition
	Download addon builder definition

Download the specified addon builder JSON definition.

Name

Panel

Description

borderColor

URL/app/{builder}/definition/{id}HTTP MethodGETPath ParametersParameterDescriptionSample Response Code Block

language	js

8Download datalist definition

black
bgColor	#fbfff5
borderStyle	solid

Download the specified addon builder page

Download the specified datalist

JSON definition.

Name

Description

URL

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

HTTP Method

GET

Path Parameters

Parameter	Description

Sample Response

Code Block

language	js

9Download form definition

Download the specified form JSON definition.

Name

DescriptionURL/app/form/definition/{id}HTTP MethodGETPath ParametersParameterDescriptionSample Response Code Block

language	js

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

Sample Response

JSON definition of the builder's page.

8

Anchor

	Download datalist definition
	Download datalist definition

Download datalist definition

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

Download the specified datalist

10Download userview definition

Download the specified userview

JSON definition.

Name

Description

URL

/app/userviewdatalist/definition/{id}

HTTP Method

GET

Path Parameters

Parameter	Description
id	Datalist ID.

Sample Response

Code Block

language	js

JSON definition of the Datalist.

9

Anchor

	Download form definition
	Download form definition

Download form definition

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

Download the specified form JSON definition.

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.

Name

Description

URL

/app/environment/findform/definition/{id}

HTTP Method

GET

Path Parameters

Parameter	Description
id	Form ID.

Sample Response

Code Block

language	js

JSON definition of the Form.

10

Anchor

	Download userview definition
	Download userview definition

Download userview definition

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

Download the specified userview JSON definition

12Get environment variable by ID

Get values of an environment variable by its specified ID

.

Name

Description

URL

/app/userview/environmentdefinition/{id}

HTTP Method

GET

Path Parameters

Parameter	Description
id	Userview ID.

Sample Response

Code Block

language	js

13Increase environment variable counter value

Increments the specified environment variable counter value by 1.

Name

DescriptionURL/app/environment/increaseCounterHTTP MethodPUTPath ParametersParameterDescriptionSample Response Code Block

language	js

JSON definition of the Userview.

11

Anchor

	Find environment variable
	Find environment variable

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.

14List created addon builder element

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

Name

Description

URL

/app/listenvironment/{builder}find

HTTP Method

GET

Path Query String Parameters

Parameter	Description

Sample Response

Code Block

language	js

15List created datalist

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

Name

DescriptionURL/app/list/datalistHTTP MethodGETPath Parameters

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

Anchor

	Get environment variable by ID
	Get environment variable by ID

Get environment variable by ID

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

Get values of an environment variable by its specified ID

ParameterDescriptionSample Response Code Block

language	js

16List created form

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

Name

DescriptionURL/app/list/formHTTP MethodGETPath ParametersParameterDescriptionSample Response Code Block

language	js

17List created userview

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

Name

DescriptionURL/app/list/userviewHTTP MethodGETPath ParametersParameterDescriptionSample Response Code Block

language	js

18List versions

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

.

Name

Description

URL

/app/versionsenvironment/{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

Anchor

	Increase environment variable counter value
	Increase environment variable counter value

Increase environment variable counter value

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

Increments the specified environment variable counter value.

Name	Description
URL	/app/environment/increaseCounter
HTTP Method	PUT
Query String

19Published version

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

20Retrieve created addon builder element as options

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

Name

DescriptionURL/app/{builder}/optionsHTTP MethodGETPath ParametersParameterDescriptionSample Response Code Block

language	js

21Retrieve created datalist as options

id	Environment variable ID with a number value only.
amount	Amount to increment environment variable. Increments by 1 by default.

Sample Response

Code Block

language	js

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

14

Anchor

	List created addon builder element
	List created addon builder element

List created addon builder element

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

List details of all created addon builder element

List label & value of all datalist

(s) present in the current app.

Name

Description

URL

/app/datalistlist/options{builder}

HTTP Method

GET

Path Parameters

Parameter	Description

Sample Response

Code Block

language	js

22Retrieve created form as options

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.

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

Description

Name

Description

URL

/app/form/options

HTTP Method

GET

Path Parameters

Parameter

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

Anchor

	List created datalist
	List created datalist

List created datalist

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

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

Name

Description

URL

/app/list/datalist

HTTP Method

GET

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

Anchor

	List created form
	List created form

List created form

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

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

Name

Description

URL

/app/list/form

HTTP Method

GET

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

Anchor

	List created userview
	List created userview

List created userview

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

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

Name

Description

URL

/app/list/userview

HTTP Method

GET

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

Anchor

	List versions
	List versions

List versions

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

List details of all app version(s) of the current app.

Name

Description

URL

/app/versions

HTTP Method

GET

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

Anchor

	Published version
	Published version

Published version

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

Get details of the currently published app version of the current app.

Name

Description

URL

/app/published

HTTP Method

GET

Parameters

-

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

20

Anchor

	Retrieve created addon builder element as options
	Retrieve created addon builder element as options

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

[
  {
    "label": "",
    "value": ""
  },
  {
    "label": "Expense Claim Data",
    "value": "API-c12135da-a5f6-41c4-ba99-bfaa16bbe636"
  },
  {
    "label": "Test API Document KB",
    "value": "API-5bc8e093-00cd-455a-a6b0-d94aa92a446f"
  }
]

21

Anchor

	Retrieve created datalist as options
	Retrieve created datalist as options

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

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

[
  {
    "label": "",
    "value": ""
  },
  {
    "label": "Expense All",
    "value": "ExpensesListAll"
  },
  {
    "label": "Expense Approved",
    "value": "ExpensesApproved"
  },
	.....
]

22

Anchor

	Retrieve created form as options
	Retrieve created form as options

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

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

[
  {
    "label": "",
    "value": ""
  },
  {
    "label": "Expense Approval Detail",
    "value": "ExpensesApprovalDetail"
  },
  {
    "label": "Expense Approval Entry",
    "value": "ExpensesApprovalEntry"
  },
	.....
]

23

Anchor

	Retrieve created userview as options
	Retrieve created userview as options

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

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

[
  {
    "label": "",
    "value": ""
  },
  {
    "label": " Expenses Claims App",
    "value": "home"
  },
  {
    "label": "Dashboard Template",
    "value": "dashboard"
  }
]

24

Anchor

	Retrieve processes as options
	Retrieve processes as options

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

Parameters

-

Sample Response

Code Block

language	js

[
  {
    "label": "",
    "value": ""
  },
  {
    "label": "Expense Approval Process (process1)",
    "value": "process1"
  },
  {
    "label": "Process 2 TEST (testprocess2)",
    "value": "testprocess2"
  }
]

25

Anchor

	Update environment variable
	Update environment variable

Update environment variable

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

Update

23Retrieve created userview as options

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

Name

DescriptionURL/app/userview/optionsHTTP MethodGETPath ParametersParameterDescriptionSample Response Code Block

language	js

24Retrieve processes as options

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

Name

DescriptionURL/app/process/optionsHTTP MethodGETPath ParametersParameterDescriptionSample Response Code Block

language	js

25Update environment variable

Update

the value of an environment variable in the current app.

Name

Description

URL

/app/environment

HTTP Method

PUT

HTTP Method

PUT

Body Parameters

Parameter	Description
id	Any existing environment variable ID.
value	Environment variable value to overwrite.
remarks	Description of environment variable to overwrite.

Path Parameters

Description

Parameter

Sample Response

Code Block

language	js

{
  "value": "string",
  "remarks": "string",
  "id": "string"
}

Space shortcuts

Page tree

Versions Compared

Old Version 37

New Version Current

Key