Delete Data Definition

DELETE /ws/rest/service/v1/ds/data-def

Version: 20.11

Purpose

Deletes data definition

Request Format

All parameters should be URL encoded.

Both input & output in JSON format in the body

options: user has to specify the type of data definition; that is, Basic, Cost Codes, Data Picker.

Note: Type is case insensitive.

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

{

"options":{"type": "Basic"},

"data":{

"data_definitions": ["simple DD1", "simple DD2"]

}

}

Sample Success Response

{

"data": [],

"message": [

{ data_definition: "Simple DD1","status": "1531","message":"You can not delete deployed definitions."} ,

{ data_definition: "Simple DD2","status": "200","message":"success"}

],

"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

1531

Cannot delete data definition

1532

data definition does not exist

3000

Partial delete

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

Delete DDS Data

Get DDS Data

Get Data Definition

Create Data Definition

Update Data Definition

Response Error Codes



Last Published Tuesday, July 1, 2025