Page History

Versions Compared

Key

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

...

DELETE

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

Request Body Parameters

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

Sample Response

Code Block

language	js
title	Response Schema

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

Delete environment variable

title

Panel

borderColor	black
bgColor	#fbfff5
borderStyle	solid

Remove the specified environment variable in the current app.

Panel

borderColor

lightgreen

borderWidth

titleBGColor

#c4ffd8

borderStyle

solid

Name	Description
URL	/app/environment/{id}

Panel

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

HTTP Method

DELETE

Path Parameters

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

Sample Response

Code Block

language	js
title	Response 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"
}

4Delete version

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

Panel

borderColor	lightgreen
borderWidth	1
titleBGColor	#c4ffd8
borderStyle	solid
title	URL

/app/delete/{version}

Panel

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

DELETE

5Deploy XPDL

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

Panel

borderColor	lightgreen
borderWidth	1
titleBGColor	#c4ffd8
borderStyle	solid
title	URL

/app/deploy/xpdl

Panel

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

POST

6Download XPDL

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

Panel

borderColor	lightgreen
borderWidth	1
titleBGColor	#c4ffd8
borderStyle	solid
title	URL

/app/xpdl

Panel

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

GET

7Download addon builder definition

Download the specified addon builder JSON definition.

Panel

borderColor	lightgreen
borderWidth	1
titleBGColor	#c4ffd8
borderStyle	solid
title	URL

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

Panel

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

GET

8Download datalist definition

Download the specified datalist JSON definition.

Panel

borderColor	lightgreen
borderWidth	1
titleBGColor	#c4ffd8
borderStyle	solid
title	URL

/app/datalist/definition/{id}

Panel

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

GET

9Download form definition

Download the specified form JSON definition.

Panel

borderColor	lightgreen
borderWidth	1
titleBGColor	#c4ffd8
borderStyle	solid
title	URL

/app/form/definition/{id}

Panel

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

GET

10Download userview definition

Download the specified userview JSON definition.

Panel

borderColor	lightgreen
borderWidth	1
titleBGColor	#c4ffd8
borderStyle	solid
title	URL

/app/userview/definition/{id}

Panel

borderColor	#f5c402
borderWidth	1
titleBGColor	#fff5cf
borderStyle	solid
title	HTTP 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

borderColor	lightgreen
borderWidth	1
titleBGColor	#c4ffd8
borderStyle	solid
title	URL

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

Panel

borderColor	lightgreen
borderWidth	1
titleBGColor	#c4ffd8
borderStyle	solid
title	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.

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.

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.

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.

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.

Panel

borderColor	lightgreen
borderWidth	1
titleBGColor	#c4ffd8
borderStyle	solid
title	URL

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

Panel

borderColor	lightgreen
borderWidth	1
titleBGColor	#c4ffd8
borderStyle	solid
title	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.

Panel

borderColor	lightgreen
borderWidth	1
titleBGColor	#c4ffd8
borderStyle	solid
title	URL

/app/published

Panel

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

GET

20Retrieve created addon builder element as options

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

Panel

borderColor	lightgreen
borderWidth	1
titleBGColor	#c4ffd8
borderStyle	solid
title	URL

/app/{builder}/options

Panel

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

GET

21Retrieve created datalist as options

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

Panel

borderColor	lightgreen
borderWidth	1
titleBGColor	#c4ffd8
borderStyle	solid
title	URL

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

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.

Panel

borderColor	lightgreen
borderWidth	1
titleBGColor	#c4ffd8
borderStyle	solid
title	URL

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

Panel

borderColor	lightgreen
borderWidth	1
titleBGColor	#c4ffd8
borderStyle	solid
title	URL

/app/process/options

Panel

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

GET

25Update environment variable

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

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 31

New Version 32

Key