Versions Compared

Key

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

...

borderColor

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
Body Parameters
ParameterDescription
idEnvironment variable ID.
valueEnvironment variable value.
remarksDescription of environment variable.
Sample Response
Code Block
languagejs
{
  "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
{
  "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

Delete 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
{
  "date": "Mon Aug 26 16:57:53 SGT 2019",
  "code": "200",
  "message": "Successful operation"
}
4Delete version
Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

Delete the specified app version of the current app.

Name

Description
URL/app/delete/{version}
HTTP MethodDELETE
Path Parameters
ParameterDescription
versionVersion of current app to remove. Expects an integer value.
Sample Response
Code Block
languagejs
{
  "date": "Mon Aug 26 17:02:35 SGT 2019",
  "code": "200",
  "message": "Successful operation"
}
5Deploy XPDL
Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

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

Name

Description
URL/app/deploy/xpdl
HTTP MethodPOST
Body Parameters
ParameterDescription
FileExpects a XPDL file.
Sample Response
Code Block
languagejs
{
  "date": "Mon Aug 26 18:17:30 SGT 2019",
  "code": "200",
  "message": "Successful operation"
}
6Download XPDL
Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

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

Name

Description
URL/app/xpdl
HTTP MethodGET
Parameters

-

Sample Response

Definition of all process(es) as XPDL.

7Download addon builder definition
Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

Download the specified addon builder page JSON definition.

Name

Description
URL/app/{builder}/definition/{id}
HTTP MethodGET
Path Parameters
ParameterDescription
builderBuilder's ID. (e.g: "api" for API Builder)
idBuilder page's ID.
Sample Response

JSON definition of the builder's page.

8Download datalist definition
Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

Download the specified datalist JSON definition.

Name

Description
URL/app/datalist/definition/{id}
HTTP MethodGET
Path Parameters
ParameterDescription
idDatalist ID.
Sample Response

JSON definition of the Datalist.

9Download form definition
Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

Download the specified form JSON definition.

Name

Description
URL/app/form/definition/{id}
HTTP MethodGET
Path Parameters
ParameterDescription
idForm ID.
Sample Response

JSON definition of the Form.

10Download userview definition
Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

Download the specified userview JSON definition.

Name

Description
URL/app/userview/definition/{id}
HTTP MethodGET
Path Parameters
ParameterDescription
idUserview ID.
Sample Response

JSON definition of the Userview.

11Find environment variable
Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

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 MethodGET
Query String Parameters
ParameterDescription
nameFilterEnvironment 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.

startOffsetStarting position of records to start query. Expects an integer.
pageSizeNumber of results to return. Expects an integer.
Sample Response
Code Block
languagejs
[
  {
    "value": "Expenses Claim",
    "remarks": null,
    "id": "AppName"
  },
  {
    "value": "4",
    "remarks": null,
    "id": "counter"
  },
  {
    "value": "8",
    "remarks": "string",
    "id": "string"
  }
]
12Get environment variable by ID
Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

Get values of an environment variable by its specified ID.

Name

Description
URL/app/environment/{id}
HTTP MethodGET
Path Parameters
ParameterDescription
idEnvironment variable ID.
Sample Response
Code Block
languagejs
{
  "value": "Expenses Claim",
  "remarks": null,
  "id": "AppName"
}
13Increase environment variable counter value
Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

Increments the specified environment variable counter value by 1.

Name

Description
URL/app/environment/increaseCounter
HTTP MethodPUT
Body Parameters
ParameterDescription
idEnvironment variable ID with a number value only.
Sample Response
Code Block
languagejs
{
  "value": "6",
  "remarks": null,
  "id": "counter"
}
14List created addon builder element
Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

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
ParameterDescription
builderBuilder's ID. (e.g: "api" for API Builder)
Query String Parameters
ParameterDescription
nameFilterBuilder 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.

startOffsetStarting position of records to start query. Expects an integer.
pageSizeNumber of results to return. Expects an integer.
Sample Response
Code Block
languagejs
[
  {
    "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"
  }
]
15List created datalist
Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

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

Name

Description
URL/app/list/datalist
HTTP MethodGET
Query String Parameters
ParameterDescription
nameFilterDatalist 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.

startOffsetStarting position of records to start query. Expects an integer.
pageSizeNumber of results to return. Expects an integer.
Sample Response
Code Block
languagejs
[
  {
    "name": null,
    "description": null,
    "dateCreated": null,
    "dateModified": null,
    "id": "ExpensesListAll"
  },
  {
    "name": null,
    "description": null,
    "dateCreated": null,
    "dateModified": null,
    "id": "ExpensesApproved"
  },
	.....
]
16List created form
Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

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

Name

Description
URL/app/list/form
HTTP MethodGET
Query String Parameters
ParameterDescription
nameFilterForm 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.

startOffsetStarting position of records to start query. Expects an integer.
pageSizeNumber of results to return. Expects an integer.
Sample Response
Code Block
languagejs
[
  {
    "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"
  },
	.....
]
17List created userview
Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

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

Name

Description
URL/app/list/userview
HTTP MethodGET
Query String Parameters
ParameterDescription
nameFilterUserview 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.

startOffsetStarting position of records to start query. Expects an integer.
pageSizeNumber of results to return. Expects an integer.
Sample Response
Code Block
languagejs
[
  {
    "name": null,
    "description": null,
    "dateCreated": null,
    "dateModified": null,
    "thumbnail": null,
    "id": "home"
  },
  {
    "name": null,
    "description": null,
    "dateCreated": null,
    "dateModified": null,
    "thumbnail": null,
    "id": "dashboard"
  }
]
18List versions
Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

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

Name

Description
URL/app/versions
HTTP MethodGET
Query String Parameters
ParameterDescription
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.

startOffsetStarting position of records to start query. Expects an integer.
pageSizeNumber of results to return. Expects an integer.
Sample Response
Code Block
languagejs
[
  {
    "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"
  }
]
19Published version
Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

Get the currently published app version of the current app.

Name

Description
URL/app/published
HTTP MethodGET
Path ParametersParameter

-

Description
Sample Response
Code Block
languagejs
20Retrieve created addon builder element as options
Panel
blackbgColor#fbfff5borderStylesolid

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

Name

DescriptionURL/app/{builder}/optionsHTTP MethodGETPath ParametersParameterDescriptionSample Response Code Block
languagejs
21Retrieve created datalist as options
Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

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

Name

DescriptionURL/app/datalist/optionsHTTP MethodGETPath ParametersParameterDescriptionSample Response Code Block
languagejs
22Retrieve created form as options
Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

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

Name

DescriptionURL/app/form/optionsHTTP MethodGETPath ParametersParameterDescription
{
  "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"
}
20Retrieve created addon builder element as options
Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

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

Name

Description
URL/app/{builder}/options
HTTP MethodGET
Path Parameters
ParameterDescription
builderBuilder's ID. (e.g: "api" for API Builder)
Query String Parameters
ParameterDescription
nameFilterBuilder 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.

startOffsetStarting position of records to start query. Expects an integer.
pageSizeNumber of results to return. Expects an integer.
Sample Response
Code Block
languagejs
[
  {
    "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"
  }
]
21Retrieve created datalist as options
Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

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

Name

Description
URL/app/datalist/options
HTTP MethodGET
Query String Parameters
ParameterDescription
nameFilterDatalist 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.

startOffsetStarting position of records to start query. Expects an integer.
pageSizeNumber of results to return. Expects an integer.
Sample Response
Code Block
languagejs
[
  {
    "label": "",
    "value": ""
  },
  {
    "label": "Expense All",
    "value": "ExpensesListAll"
  },
  {
    "label": "Expense Approved",
    "value": "ExpensesApproved"
  },
	.....
]
22Retrieve created form as options
Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

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

Name

Description
URL/app/form/options
HTTP MethodGET
Query String Parameters
ParameterDescription
nameFilterForm 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.

startOffsetStarting position of records to start query. Expects an integer.
pageSizeNumber of results to return. Expects an integer.
Sample Response
Code Block
languagejs
[
  {
    "label": "",
    "value": ""
  },
  {
    "label": "Expense Approval Detail",
    "value": "ExpensesApprovalDetail"
  },
  {
    "label": "Expense Approval Entry",
    "value": "ExpensesApprovalEntry"
  },
	.....
]
23Retrieve created userview as options
Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

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

Name

Description
URL/app/userview/options
HTTP MethodGET
Query String Parameters
ParameterDescription
nameFilterUserview 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.

startOffsetStarting position of records to start query. Expects an integer.
pageSizeNumber of results to return. Expects an integer.
Sample Response
Code Block
languagejs
[
  {
    "label": "",
    "value": ""
  },
  {
    "label": " Expenses Claims App",
    "value": "home"
  },
  {
    "label": "Dashboard Template",
    "value": "dashboard"
  }
]
24Retrieve processes Sample Response Code Block
languagejs
23Retrieve created userview as options
Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

List label & value of all userviewprocess(ses) present in the current app.

Description

-

Name

Description
URL/app/userviewprocess/options
HTTP MethodGET
Path ParametersParameter
Sample Response
Code Block
languagejs
24Retrieve processes as options
Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

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

Name

Description
URL/app/process/options
HTTP MethodGET
Path Parameters
ParameterDescription
Sample Response
js
Code Block
language
[
  {
    "label": "",
    "value": ""
  },
  {
    "label": "Expense Approval Process (process1)",
    "value": "process1"
  },
  {
    "label": "Process 2 TEST (testprocess2)",
    "value": "testprocess2"
  }
]
25Update environment variable
Panel
borderColorblack
bgColor#fbfff5
borderStylesolid

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

Name

Description
URL/app/environment
HTTP MethodPUT
Path Parameters
ParameterDescription


Sample Response
Code Block
languagejs

...