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
|
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=purgeAttributesExample 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",
"purgeDataOnly"="true"
}
}Note: In the request, if you haven't included any options, or have included
option=purgeAttributes, then the response displays the purgeDataOnly as true to denote only values are deleted. If you included the option=purgeAllData, then the response displays the purgeDataOnly as false to denote that data and crosswalks are deleted.