Create DDS Definition
POST /ws/rest/service/v1/ds/dds
Version: 20.10
Purpose
Creates Dynamic Data Set Definitions.
Request Format
All parameters should be URL encoded.
Both input & output in JSON format in the body.
Request Parameters
The following fields can be included in the request:
| Request Parameter | Required? | Description |
|---|---|---|
| dds_name | Yes | Specify the unique DDS name. |
| master_de_name | Yes | Specify the master DE. |
| data_element in value_set | Yes if value_set is included in the request. | |
| order | Yes | Order of the value_set DEs. |
| description | No |
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 request
{
"data": [
{
"dds_name": "sampleDDS",
"master_de_name": "countryDE",
"dds_desc": "sampleDDS",
"value_set":[
{
"data_element":"stateDE",
"order":1
},
{
"data_element":"cityDE",
"order":2
}
],
"behavior_set":[
{"data_element":"zipcodeDE"}
]
},
{
"dds_name": "sampleDDS2",
"master_de_name": "countryDE",
"dds_desc": "sampleDDS",
"value_set":[
{
"data_element":"stateDE",
"order":2
},
{
"data_element":"cityDE",
"order":1
}
],
"behavior_set":[
{"data_element":"zipcodeDE"}
]
}
]
}
Sample Response
This is an example of a partially successful response.
{
"data": [
{
"id":12,
"dds_name": "sampleDDS2",
"master_de_name": "countryDE",
"dds_desc": "sampleDDS",
"value_set":[
{
"data_element":"stateDE",
"order":1
},
{
"data_element":"cityDE",
"order":2
}
],
"behavior_set":[
{
"data_element":"zipcodeDE"
}
]
}]
},
"message": [
{
"dds_name": sampleDDS
"message": Name already exists. Enter a different name.,
"status": 1500
},
{
"dds_name": "sampletest1",
"message": "usrServiceCategoryPD122",
"status": 200
}
],
"status": 3000
}
Supported Validation Message 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 |
| 1500 | Name already exists. Enter a different name. |
| 3002 | Invalid JSON input |