MDM

Delete Records List

Function: delete_records_list Type: API Endpoint (POST)

Purpose:
Deletes records from a specified table in the customer database based on the provided query.

URL:
POST /api/mdm/delete_records

Parameters:

  • Table_Name (Header, required): The name of the table to be deleted from.
  • Customer_Key (Header, required): A base64 encoded string containing lscode and firmcode for the customer.
  • request_data (JSON Body, required): A JSON object containing the deletion details.

Request Body:

    {
        "delPartialRecords": <delPartialRecords>,
        "delFullRecords": <delFullRecords>,
        "Customcol": "<Customcol>",
        "Date_Of_Item_Created": "<Date_Of_Item_Created>",
    }
post/api/mdm/delete_records

Headers

Table-Namestring required
Customer-Keystring required

Request body

delFullRecordsboolean nullable

If true, delete all records.

delPartialRecordsboolean nullable

If true, delete records based on specific conditions.

Customcolstring nullable

The column to filter for partial deletions.

Date_Of_Item_Createdstring nullable

Date range for partial deletion (e.g., '2023-01-01, 2023-12-31').

Response

Successful Response

{"stackTrail":"paths:/api/mdm/delete_records:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}

Changes

No recorded changes to this endpoint across all 1 revision of this API.