Delete DDS Data

DELETE /ws/rest/service/v1/ds/ddsdata

Version: 20.10

Purpose

Deletes DDS data. Multiple DDS can be deleted in one request.

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:

Request Parameter

Required?

Description

dds_name

Yes

The name of the data definition set that needs to be deleted.

id

Yes

The ID of the dds data set.

Note: Use id vs value set and behavior set combination.

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 for deleting a DDS, "sampleDDS".

{

"data": {

"dds_name": "sampleDDS",

"id":[712,714]

}

}

Sample Failed Response

This is an example of partial failed response with a status code 3000.

{

"data": {},

"message": [

{ id: "712","status": "200","message":"success"},

{ id: "714","status": "1509","message":"DDS does not exist"}

],

"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

3002

Invalid JSON input

Related Topics

Data Structure Setup

Authorization

Get Data Elements

Create Data Element

Update Data Element

Delete Data Elements

Create DDS Definition

Update DDS Definition

Delete DDS Definition

Get DDS Definition

Create DDS Data

Update DDS Data

Get DDS Data

Get Data Definition

Create Data Definition

Update Data Definition

Delete Data Definition

Response Error Codes



Last Published Tuesday, July 1, 2025