Get DDS Definition

GET /ws/rest/service/v1/ds/dds

Version: 20.10

Purpose

Gets Dynamic Data set Definition.

Request Format

All parameters should be URL encoded.

Both input & output in JSON format in the body.

Request Parameters

The following parameters can be included in the URL query parameter, filter. Use the following format:

filter= {"dds_name":"<value>}

Filter Parameter	Description
dds_name	The name of the data definition set.
master_de_name	The master data element.
dds_desc	Description of the data definition set.
master_de_label	Form label of the Master DE.

Note:

If no filter options provided service will return all DDS.

The following parameters can be included in the request:

Request Parameter	Required?	Description
dds_name	No	The name of the data definition set.
dds_desc	No	Description of the data definition set.
master_de_name	No	The master data element for the data definition set.
master_de_label	No	Form label of the master data element.

It has a "contains" performs a case insensitive search.

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 Filter Query in the Request

This is an example of a filter query.

"filter":

{

"dds_name": "sampleDDS",

"master_de_name": "countryDE",

"dds_desc": "sampleDDS",

"master_de_label": "my sample"

}

Sample Success Response

This is an example of a successful response with status code 200.

{

"data": [

{

"id":12,

"dds_name": "sampleDDS",

"master_de_name": "countryDE",

"dds_desc": "sampleDDS",

"master_de_label": "my sample"

"value_set":[

{"data_element":"stateDE","order":1},

{"data_element":"cityDE","order":2}

],

"behavior_set":[

{"data_element":"zipcodeDE"}

]

}]

},

"message": ["Success"],

"status":200

}

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