Update DDS Definition
PUT /ws/rest/service/v1/ds/dds
Version: 20.10
Purpose
To Update Dynamic Data Set Definition. Action JSON value 'delete' will used to remove any value or Behavior set data element for DDS Definition.
Previously existing value set or Behavior set data elements will be reordered based on the latest order provided in values set/Behavior set in update DDS definition.
Request Format
All parameters should be URL encoded.
Both input and output in JSON format in the body.
Request Parameters
The following parameters can be included in the request:
id : (Required) Specify the DDS id which needs to be updated.
Note: action: "delete" required to delete value set or behavior set data element in DDS Definition.
Response Format
A JSON object is returned in the following format:
{
"data": [],
"message": [],
"status": <REST status code value>
}
A successful response displays a status code 200.
A failed response displays a message with a status code.
Sample Request
This is an example of a request to update the following DDS definitions.
{
"data": [
{ "id":12,
"dds_name": "sampleDDS",
"master_de_name": "countryDE",
"dds_desc": "desc",
"value_set":[
{
"data_element":"stateDE",
"order":1
},
{
"data_element":"cityDE",
"action":"delete"
},
{
"data_element":"address",
"order":2
}
],
"behavior_set":[
{
"data_element":"zipcodeDE"
}
]
},
{
"dds_name": "sampleDDS2",
"master_de_name": "countryDE",
"dds_desc": "desc",
"value_set":[
{
"data_element":"stateDE",
"order":1
},
{
"data_element":"cityDE",
"order":2
}
],
"behavior_set":[
{
"data_element":"zipcodeDE"
}
]
}
]
}
Sample Success Response
This is an example of a successful response to the request.
{
"data": [
{
"id":12,
"dds_name": "sampleDDS",
"master_de_name": "countryDE",
"dds_desc": "desc",
"value_set":[
{
"data_element":"stateDE",
"order":1
},
{
"data_element":"address",
"order":2
}
],
"behavior_set":[
{
"data_element":"zipcodeDE"
}
]
}]
},
"message": [
{
"dds_name": "sampleDDS"
"message": "usrServiceCategoryPD122",
"status": 200
},
{
"dds_name": "sampleDDS2",
"message": Name already exists. Enter a different name.,
"status": 1500
}
],
"status": 3000
}
Supported Validation Messages and Status Codes
The following status codes and messages can display in the response to a request.
Status Code | Validation Message |
|---|---|
200 | Success |
1101 | Empty or Invalid JSON data |
3000 | Partial create |
3002 | Invalid JSON input |
Related Topics
Last Published Tuesday, July 1, 2025