API Structure

1) getPageComponents

This API provides the components to be shown in page.

Request Details

  • method: POST
  • body:
{
keys: {
}
}

Response

{
header: {
title: ''
sortNum: 1,
noOfCols: 2,
noOfRowsVisible: 3,
style: {
headerBgColor: '', //hex or RGB Codes
headerColor: '',
titleBgColor: '',
titleColor: ''
}
},
search: {
title: '',
sortNum: 2,
noOfCols: 2,
noOfRowsVisible: 2,
style: {
headerBgColor: '', //hex or RGB Codes
headerColor: '',
titleBgColor: '',
titleColor: '',
buttonBgColor: '',
buttonColor: ''
},
advancedLabel: {
moreLabel: '',
lessLabel: ''
},
captchaRequired: true/false
},
details: {
title: '',
viewType: '', //tile/table/both
viewTypeOptions: {
tile: {
noOfCols: 2,
noOfRowsVisible: 3
},
table: {
noOfCols: 5
}
},
options: {
countToLoadData: 4,
isEditable: true
}
},
notes: {
sortNum: 3
},
footer: {
sortNum: 5,
noOfCols: 3
}
}

2) getComponentsData

Request Details

  • method: POST
  • body:
{
keys: {
}
}

Response

{
header: {
data: {
fieldKey: {
label: '',
dataType: '',
sortNum: 1,
colsTaken: 1,
dataTypeOptions: {
},
value: ''
}
},
actions: {
}
},
search: {
data: {
fieldKey: {
label: '',
displayType: '',
value: '',
sortNum: 1,
cols: 1,
displayTypeOptions: {
},
dataArr: [ // in cases of dropdown/checkbox/radio buttons
{
id: '',
label: '',
value: ''
}
],
validations: {
isRequired: true/false,
lessThan: {
value: '',
fields: [],
message: ''
},
greaterThan: {
value: '',
fields: [],
message: ''
},
charRange: {
min: '',
max: '',
message: ''
},
regEx: {
value: '',
message: ''
}
}
}
},
actions: [
{
id: '',
label: '',
tooltip: '',
externalLink: '',
apiCall: {
url: '',
method: '',
body: {}
}
}
]
},
footer: {
data : {
fieldKey: {
label: '',
dataType: '',
sortNum: 1,
cols: 1,
dataTypeOptions: {
},
value: ''
}
},
actions: {
}
},
notes: {
}
}

3) getDetailIdsAndDisplay

Request Details

  • method: POST
  • body:
{
keys: {
}
}

Response

{
displayData: {
fieldKey: {
label: '',
sortNum: '',
dataType: '',
displayType: '',
colsTaken: '',
dataArr:[],
newTableRow: true/false,
displayTypeOptions: '',
validations: {
isRequired: true/false,
lessThan: {
value: '',
fields: []
},
greaterThan: {
value: '',
fields: []
},
charRange: {
min: '',
max: ''
},
regEx: ''
}
}
},
actionIcons: [
{
id: '',
name:'',
label:'',
tooltip:'',
externalLink: '',
apiCall: {
url: '',
method: '',
body: {}
}
}
],
actionButtons: [
{
id: '',
label: '',
tooltip: '',
externalLink: '',
apiCall: {
url: '',
method: '',
body: {}
}
}
]
idArr: []
}

4) getDetailsData

Request Details

  • method: POST
  • body:
{
keys: {
},
body: {
idArr: []
}
}

Response

{
data: [
{
fieldKey: ''
}
]
}

5) performAction

Request Details

  • method: POST
  • body:
{
keys: {
},
body: {
action:'',
data: ''
}
}

Response

{
status: '',
statusMessage: '',
statusCode:''
}