This API allows user to delete one or more topics.
If topics are used in portals but they are not the only ones, the operation will succeed only if the client supplies 'deleteIfUsedInPortal' query parameter.
Additionally, if any of the topics contain subtopics, the operation will succeed only if the client supplies 'deleteSubtopics' query parameter.
Permissions
The user must have 'Delete' action on 'Topic' resource.
The user sending the request should be from the same or shared department as the topic.
Preconditions
If supplied topics are the only ones used in a portal, the operation will not be successful.
If 'deleteIfUsedInPortal' query parameter is not supplied, all of the topics being deleted must not be used in any portal in order for the operation to succeed.
If 'deleteSubtopics' query parameter is not supplied, all of the topics being deleted must not contain any subtopics in order for the operation to succeed.
The topics being deleted must not be Auto Generated Topic.
All topic IDs provided in path must be from same department.
SecurityoAuthUser
Request
path Parameters
ID
required
string
The comma separated Ids of the topics on which operation is performed.
Examples:
202200000002268,202200000002269
query Parameters
deleteSubtopics
string
Single value is allowed i.e "yes". It means the user is making an explicit request to delete all the subtopics of each topic being deleted. If this parameter is absent and any of the topics specified in the URI contains one or more subtopics, the server will return '412 - Precondition Failed'.
Example: deleteSubtopics=yes
deleteIfUsedInPortal
string
Single value is allowed i.e "yes". It means the user is making an explicit request to delete specified topics even if some of them are used in a portal(s). If this parameter is absent and any of the topics specified in the URI are used in a portal(s), the server will return '412 - Precondition Failed'.