POST /ws/rest/service/v1/ds/data-elements
Version: 20.10
Purpose:
To create custom data elements
Input:
All parameters should be URL encoded.
Both input & output in JSON format in the body
Create Data Element input JSON
{
"data": [
{
"data_element": "sampleDE",
"data_definition": "Decimal Amount",
"form_label": "Sample Decimal Element",
"description": "Test DE",
"decimal_format": "5"
},
{
"data_element": "sampleImgDE",
"data_definition": "Image Picker",
"form_label": "Sample Image Picker",
"description": "Test Image DE",
"tooltip": "Test Image DE"
}
]
}
Input JSON field description:
- Required Fields:
- data_element (Required): specify the unique date element name
- data_definition (Required): specify the field definition to create data element of that type
- form_label (Required): specify DE Label name
- Non-required Fields:
- Description
- Tooltip
- Valid Fields based on the data_definition value:
data_definition | Required Field Name |
|---|---|
Image Picker | height (required) |
SYS Rich Text | height (required) |
textarea (as data_source) | no_of_lines (required) |
Decimal Amount | decimal_format (not required - default value is '8') |
SYS Numeric Query Based | hide_currency_symbol (not required - valid values are Yes/No - default value will be No) |
Output:
JSON object containing 'status', 'data', 'message'
Create 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
}
],
"message": [
{
"data_element": "sampleDE",
"message": "success"
},
{
"data_element": "sampleImgDE",
"message": "height is required",
"status": 505
}
],
"status": 3000
}
Status codes are:
1> 200, for success
2> 3000, for partial create.
3> 3002, for invalid JSON input
4> 1101, for Empty or Invalid JSON data