Deleting reference data

Delete the reference data.

Before you begin

  • Admin access is required. Only admins have the necessary permissions for this activity.
  • If you do not have admin access but hold a custom role, ensure that you have the write access specifically for the project where you intend to delete the reference data.

About this task

Complete the following steps:

Procedure

  1. In a REST client platform, add the authentication details of the tenant from where you want to delete the reference data. 
    
//In case of Instance API key 
Headers:
{
"x-instance-api-key": "instance_api_key"
}
 
// In case of MCSP or ISV token
Headers:
{
"Authorization": "mcsp_or_isv_token"
}
  2. Make a DELETE request at the URL of the project.

    URL syntax: <domain>apis/v1/rest/projects/<project_name>/referencedata/<referencedata_name>

    In this URL request, <project_name> is the name or UID of the project from where you want to delete the reference data and <referencedata_name> is the name of the reference data you want to delete.
    Note: If the reference data you want to delete is used in a Flow service, it cannot be deleted directly. You must first remove the reference data from the relevant Flow service and then delete it.

    Method: DELETE

    If the request is successful, you receive the response code for success.

    { 

    "output": 
	{ 
	"status": true, 
	"message": "ReferenceData ref1 deleted successfully." 
    } 
}