| 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 | 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 | 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"
} |
|
|
---|
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 | | 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"
} |
|
|
3 | Anchor |
---|
| Delete environment variable |
---|
| Delete environment variable |
---|
| Remove the specified Delete environment variable in the current app.
| Panel |
---|
borderColor | lightgreenblack |
---|
borderWidthbgColor | 1#fbfff5 |
---|
titleBGColorborderStyle | #c4ffd8 |
---|
borderStyle | solid | titlesolid |
| Delete the specified environment variable in the current app. |
Name | Description |
---|
URL | /app/environment/{id} |
panelborderColor#f5c402borderWidth1titleBGColor | #fff5cf |
---|
borderStyle | solid |
---|
title | HTTP Method |
---|
DELETE | id | ID of environment variable to remove. Expects a string. |
| Sample Response | Code Block |
---|
| {
"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} |
| 4 | Delete 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 | 5Path Parameters | Parameter | Description |
---|
version | Version of current app to remove. Expects an integer value. |
| Sample Response | Code Block |
---|
| {
"date": "Mon Aug 26 17:02:35 SGT 2019",
"code": "200",
"message": "Successful operation"
} |
|
|
5 | | Deploy 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 | #f5c402black |
---|
borderWidthbgColor | 1#fbfff5 |
---|
titleBGColor | #fff5cf |
---|
borderStyle | solid |
---|
title | HTTP Method |
---|
| POST |
| 6 | Download XPDL | Deploy a XPDL file as a new/updated process design to the current app. |
Download the specified process definition as a XPDL file into the current machine. Panel |
---|
borderColor | lightgreen |
---|
borderWidth | 1 |
---|
titleBGColor | #c4ffd8 |
---|
borderStyle | solid | titlepanelborderColor#f5c402borderWidth1titleBGColor | #fff5cf |
---|
borderStyle | solid |
---|
title | HTTP Method |
---|
GET | |
7 | Download 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 |
|
8 | Download 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 |
|
| Sample Response | Code Block |
---|
| {
"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 | Definition of all process(es) as XPDL. |
|
7 | Anchor |
---|
| Download addon builder definition |
---|
| Download addon builder definition |
---|
| Download addon builder definition
| Panel |
---|
borderColor | black |
---|
bgColor | #fbfff5 |
---|
borderStyle | solid |
---|
| Download the specified addon builder page JSON definition. |
Name | Description |
---|
URL | /app/{builder} |
| 9 | Download form definition | Download the specified form JSON definition. Panel |
---|
borderColor | lightgreen |
---|
borderWidth | 1 |
---|
titleBGColor | #c4ffd8 |
---|
borderStyle | solid |
---|
title | URL |
---|
| /app/formpanelborderColor#f5c402borderWidth1titleBGColor | #fff5cf |
---|
borderStyle | solid |
---|
title | HTTP Method |
---|
GET | | 10 | Download userview definition | 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 definitionDownload the specified userview JSON definition.
| Panel |
---|
borderColor | lightgreenblack |
---|
borderWidthbgColor | 1#fbfff5 |
---|
titleBGColorborderStyle | #c4ffd8 |
---|
borderStyle | solid | titlesolid |
| Download the specified datalist JSON definition. | userview Panel |
---|
borderColor | #f5c402 |
---|
borderWidth | 1 |
---|
titleBGColor | #fff5cf |
---|
borderStyle | solid |
---|
title | HTTP Method |
---|
| GET |
HTTP Method | GET | Path Parameters | Parameter | Description |
---|
id | Datalist ID. |
| Sample Response | 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. |
| 11 | Find 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 | titleenvironment/find Panel |
---|
borderColor | #f5c402 |
---|
borderWidth | 1 |
---|
titleBGColor | #fff5cf |
---|
borderStyle | solid |
---|
title | HTTP Method |
---|
| GET |
| 12 | Get environment variable by ID | form/definition/{id} | HTTP Method | GET | Path Parameters | Parameter | Description |
---|
id | Form ID. |
| Sample Response | 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. |
Get values of an environment variable by its specified ID. Panel |
---|
borderColor | lightgreen |
---|
borderWidth | 1 |
---|
titleBGColor | #c4ffd8 |
---|
borderStyle | solid | titleenvironmentpanelborderColor#f5c402borderWidth1titleBGColor#fff5cf | borderStyle | solid |
---|
title | HTTP Method |
---|
GET | | 13 | Increase environment variable counter value | | Sample Response | 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. |
Increments the specified environment variable counter value by 1. Panel |
---|
borderColor | lightgreen |
---|
borderWidth | 1 |
---|
titleBGColor | #c4ffd8 |
---|
borderStyle | solid | titleincreaseCounterpanelborderColor#f5c402borderWidth1titleBGColor | #fff5cf |
---|
borderStyle | solid |
---|
title | HTTP Method |
---|
PUT | |
14 | List 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 |
|
15 | List 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 |
|
16 | List 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 |
|
17 | List 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 |
|
18 | List 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 |
|
19 | Published 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 |
|
20 | Retrieve 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 |
|
21 | Retrieve 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 |
|
22 | Retrieve 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 |
|
23 | Retrieve 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 |
|
24 | Retrieve 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 |
|
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 |
---|
| [
{
"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. |
Name | Description |
---|
URL | /app/environment/{id} | HTTP Method | GET | Path Parameters | Parameter | Description |
---|
id | Environment variable ID. |
| Sample Response | Code Block |
---|
| {
"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 Parameters | Parameter | Description |
---|
id | Environment variable ID with a number value only. | amount | Amount to increment environment variable. Increments by 1 by default. |
| Sample Response | Code Block |
---|
| {
"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(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 |
---|
| [
{
"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 |
---|
| [
{
"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 |
---|
| [
{
"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 |
---|
| [
{
"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 |
---|
| [
{
"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 |
---|
| {
"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 |
---|
| [
{
"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 |
---|
| [
{
"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 |
---|
| [
{
"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 |
---|
| [
{
"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 |
---|
| [
{
"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 |
---|
|
| 25 | Update environment variable | Update the value of an environment variable in the current app. | panel borderColorlightgreen | borderWidth | 1 |
---|
titleBGColor | #c4ffd8 |
---|
borderStyle | solid |
---|
title | URL |
---|
URL | /app/environment | 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. |
| Sample Response | Code Block |
---|
| {
"value": "string",
"remarks": "string",
"id": "string"
} |
|
/app/environment | Panel |
---|
borderColor | #f5c402 |
---|
borderWidth | 1 |
---|
titleBGColor | #fff5cf |
---|
borderStyle | solid |
---|
title | HTTP Method |
---|
| PUT |