Page History

Versions Compared

Key

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

...

Name

Description

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

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

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

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

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

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

Download addon builder definition

Download the specified addon builder JSON definition.

Name

Description

URL

HTTP Method

Path Parameters

Parameter

Description

Sample Response

Code Block

language	js

Panel

borderColor	lightgreen
borderWidth	1
titleBGColor	#c4ffd8
borderStyle	solid
title	URL

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

panel

HTTP Method

borderColor

GET

#f5c402

Path Parameters

borderWidth

Parameter

Description

titleBGColor

Sample Response

#fff5cf

Code Block

borderStyle

language

solidtitleHTTP MethodGET

8Download datalist definition

Download the specified datalist JSON definition.

Name

Description

URL

HTTP Method

Path Parameters

Parameter

Description

Sample Response

Code Block

language	js

Panel

borderColor	lightgreen
borderWidth	1
titleBGColor	#c4ffd8
borderStyle	solid
title	URL

/app/datalist/definition/{id}

panel

HTTP Method

borderColor

GET

#f5c402

Path Parameters

borderWidth

Parameter

Description

titleBGColor

Sample Response

#fff5cf

Code Block

borderStylesolidtitleHTTP MethodGET

language	js

9Download form definition

Download the specified form JSON definition.

Name

Description

URL

HTTP Method

Path Parameters

Parameter

Description

Sample Response

Code Block

language	js

PanelborderColorlightgreenborderWidth1

titleBGColor#c4ffd8borderStylesolidtitle

URL	/app/form/definition/{id}

panel

HTTP Method

borderColor

GET

#f5c402

Path Parameters

borderWidth

Parameter

Description

titleBGColor

Sample Response

#fff5cf

Code Block

borderStyle

language

solidtitleHTTP MethodGET

10Download userview definition

Download the specified userview JSON definition.

Description

Name

Description

URL

HTTP Method

Path Parameters

Parameter

Sample Response

Code Block

language	js

Panel

borderColor	lightgreen
borderWidth	1
titleBGColor	#c4ffd8
borderStyle	solid
title	URL

/app/userview/definition/{id}

panel

HTTP Method

borderColor

GET

#f5c402

Path Parameters

borderWidth

Parameter

Description

titleBGColor

Sample Response

#fff5cf

Code Block

borderStylesolidtitleHTTP MethodGET

language	js

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

HTTP Method

GET

Path Parameters

Parameter	Description

Sample Response

Code Block

language	js

PanelborderColorlightgreenborderWidth

1titleBGColor#c4ffd8borderStylesolidtitleURL/app/environment/find

Panel

borderColor	#f5c402
borderWidth	1
titleBGColor	#fff5cf
borderStyle	solid
title	HTTP Method

GET

12Get environment variable by ID

Get values of an environment variable by its specified ID.

Name

Description

URL

/app/environment/{id}

HTTP Method

GET

Path Parameters

Parameter	Description

Sample Response

Code Block

language	js

PanelborderColorlightgreenborderWidth1titleBGColor#c4ffd8borderStylesolidtitle

URL/app/environment/{id}

Panel

borderColor	#f5c402
borderWidth	1
titleBGColor	#fff5cf
borderStyle	solid
title	HTTP Method

GET

13Increase environment variable counter value

Increments the specified environment variable counter value by 1.

Name

Description

URL

/app/environment/increaseCounter

HTTP Method

PUT

Path Parameters

Parameter	Description

Sample Response

Code Block

language	js

Panel

borderColor	lightgreen
borderWidth	1
titleBGColor	#c4ffd8
borderStyle	solid
title	URL

/app/environment/increaseCounter

panel

borderColor	#f5c402
borderWidth	1
titleBGColor	#fff5cf
borderStyle	solid
title	HTTP Method

PUT

14List created addon builder element

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

Sample Response

Code Block

language	js

Panel

borderColor	lightgreen
borderWidth	1
titleBGColor	#c4ffd8
borderStyle	solid
title	URL

/app/list/{builder}

Panel

borderColor	#f5c402
borderWidth	1
titleBGColor	#fff5cf
borderStyle	solid
title	HTTP Method

GET

15List created datalist

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

Name

Description

URL

/app/list/datalist

HTTP Method

GET

Path Parameters

Parameter	Description

Sample Response

Code Block

language	js

Panel

borderColor	lightgreen
borderWidth	1
titleBGColor	#c4ffd8
borderStyle	solid
title	URL

/app/list/datalist

Panel

borderColor	#f5c402
borderWidth	1
titleBGColor	#fff5cf
borderStyle	solid
title	HTTP Method

GET

16List created form

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

Name

Description

URL

/app/list/form

HTTP Method

GET

Path Parameters

Parameter	Description

Sample Response

Code Block

language	js

panel

borderColor	lightgreen
borderWidth	1
titleBGColor	#c4ffd8
borderStyle	solid
title	URL

/app/list/form

Panel

borderColor	#f5c402
borderWidth	1
titleBGColor	#fff5cf
borderStyle	solid
title	HTTP Method

GET

17List created userview

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

Name

Description

URL

/app/list/userview

HTTP Method

GET

Path Parameters

Parameter	Description

Sample Response

Code Block

language	js

PanelborderColor

lightgreenborderWidth1titleBGColor#c4ffd8borderStylesolidtitleURL/app/list/userview

Panel

borderColor	#f5c402
borderWidth	1
titleBGColor	#fff5cf
borderStyle	solid
title	HTTP Method

GET

18List versions

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

Name

Description

URL

/app/versions

HTTP Method

GET

Path Parameters

Parameter	Description

Sample Response

Code Block

language	js

PanelborderColorlightgreenborderWidth1titleBGColor#c4ffd8borderStylesolidtitle

URL/app/versions

Panel

borderColor	#f5c402
borderWidth	1
titleBGColor	#fff5cf
borderStyle	solid
title	HTTP Method

GET

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

Panel

borderColor	lightgreen
borderWidth	1
titleBGColor	#c4ffd8
borderStyle	solid
title	URL

/app/published

PanelborderColor#f5c402borderWidth1titleBGColor#fff5cfborderStylesolidtitleHTTP Method

GET

20Retrieve created addon builder element as options

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

Panel

borderColor	lightgreen
borderWidth	1
titleBGColor	#c4ffd8
borderStyle	solid
title	URL

/app/{builder}/options

PanelborderColor#f5c402borderWidth1titleBGColor#fff5cfborderStylesolid

titleHTTP MethodGET

21Retrieve created datalist as options

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

PanelborderColorlightgreenborderWidth1titleBGColor#c4ffd8

borderStylesolidtitleURL/app/datalist/options

Panel

borderColor	#f5c402
borderWidth	1
titleBGColor	#fff5cf
borderStyle	solid
title	HTTP Method

GET

22Retrieve created form as options

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

Panel

borderColor	lightgreen
borderWidth	1
titleBGColor	#c4ffd8
borderStyle	solid
title	URL

/app/form/options

Panel

borderColor	#f5c402
borderWidth	1
titleBGColor	#fff5cf
borderStyle	solid
title	HTTP Method

GET

23Retrieve created userview as options

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

PanelborderColorlightgreenborderWidth1titleBGColor

#c4ffd8borderStylesolidtitleURL/app/userview/options

Panel

borderColor	#f5c402
borderWidth	1
titleBGColor	#fff5cf
borderStyle	solid
title	HTTP Method

GET

24Retrieve processes as options

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

Panel

borderColor	lightgreen
borderWidth	1
titleBGColor	#c4ffd8
borderStyle	solid
title	URL

/app/process/options

PanelborderColor#f5c402borderWidth1titleBGColor#fff5cf

borderStylesolidtitleHTTP MethodGET

25Update environment variable

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

Panel

borderColor	lightgreen
borderWidth	1
titleBGColor	#c4ffd8
borderStyle	solid
title	URL

/app/environment

Panel

borderColor	#f5c402
borderWidth	1
titleBGColor	#fff5cf
borderStyle	solid
title	HTTP Method

PUT

Space shortcuts

Page tree

Versions Compared

Old Version 36

New Version 37

Key