Get Data Elements

GET /ws/rest/service/v1/ds/data-elements

Version: 20.10

Purpose:

To get list of custom data elements

Input:

All parameters should be URL encoded.

Path Parameter

filter =

{

"data_element": "",

"data_definition": "Decimal Amount" ,

"form_label": "" ,

"description": "" ,

"tooltip": ""

}

Notes:

All field values in the filter object are case insensitive
If filter object is not provided in the request then all data elements list will be returned
Condition type contains will be used to fetch the data elements
Filter condition will be applied only if the provided filter values are not-null/non-empty.

Output:

JSON object containing 'status', 'data', 'message'

Get Data Element ouptut JSON

{

"data": [

{

"data_element": "sampleDE",

"data_definition": "Decimal Amount",

"form_label": "Sample Decimal Element",

"description": "Test DE",

"tooltip": null,

"decimal_format": "5",

"Pre-Defined Category": null

},

{

"data_element": "sampleDE2",

"data_definition": "Decimal Amount",

"form_label": "Sample Decimal Element 2",

"description": "Decimal DE",

"tooltip": null,

"decimal_format": "6",

"Pre-Defined Category": null

}, ...

],

"message": [

"success"

],

"status": 200

}

Status codes are:

1> 200, for success

Related Topics