Delete a Source System

Learn how to delete an existing source system in a configuration.

You can delete the source system by posting a request. The response returns a JSON that displays the attributes of the removed source type and the result of the deletion request.

Request

DELETE {TenantURL}/{source system URI}

Parameters


Type	Name	Required	Description
Header	Content-Type	Yes	The value should be "Content-Type: application/json"
Header	Authorization	Yes	The value should be "Content-Type: application/json"
Tasks	option	No	Valid values include purgeAttributes (default) Deletes all attribute values for a source, but preserves the crosswalks and the source used for the configuration. purgeAllData Deletes all attribute values and crosswalks for a source, and the source used for the configuration.

Note: To avoid the validation exception, if the source that you want to delete exists in any other section apart from the sources section, you must manually delete the source before posting the Delete Source API request. For example, the sourcesUriOrder or immutableForSources section.

Response

If the source type is deleted successfully, then the response contains a JSON with the details of the deleted source type. The JSON will also contain a Response field, which displays a comment about the delete operation and the response definition of the background task that has started.

Note: The response contains the definition of the background task only if the purgeAllData task is set to true.

The task status can be retrieved using the Get Tasks History for Tenant API. For more information, see Get Task by ID for Tenant.

Example Request

DELETE {TenantURL}/configuration/sources/AHA?option=purgeAttributes

Example Response

{
   "sourceType":{
      "URI":"configuration/sources/AHA",
      "label":"AHA",
      "description":"AMERICAN HOSPITAL association",
      "abbreviation":"AHA",
      "icon":"images/source/source_s.png"
   },
   "Response":"Source type 'AHA' deletion background task scheduled. To see its
status please use the tasks endpoints.",
   "Background task":{
      "numberOfProcessedObjects":0,
      "name":"Purge data by 'AHA' source type background task. Started by mike",
      "tenant":"tenant",
      "started":"05-27-2014 13.55",
      "throughput":0,
      "current":"05-27-2014 13.55"
   }
}

Accelerate the Value of Data