Delete Maps and UDs by Metadata - Fluid Topics - 3.6

Use Fluid Topics Web API

Product
Fluid Topics
FT_Version
3.6
Category
Technical Notes
language
English

This web service deletes all the publications (Maps and Unstructured Documents) and their topics based on selected metadata.

If there is no metadata given, the web service returns a 400 error code.

Before running this web service, we recommend a dry run by using the Get Maps and UDs by Metadata web service.

Method

Endpoint

DELETE

/api/admin/khub/publications?metadata1=value1&...&metadataN=valueN

Where metadata=value is any metadata key-value couple that differentiates the publication. Use as many metadata as needed to define unique content.

Example: https://myportal.fluidtopics.net/api/admin/khub/publications?version=3.0&Category=Reference%20Guide

Return codes

Return Code

Description

202 ACCEPTED

The deletion instruction was sent to the Fluid Topics processing pipeline. Returns empty JSON.

400 BAD REQUEST

Invalid query.

500 INTERNAL SERVER ERROR

The Fluid Topics Server failed to respond.

To avoid deleting all the KHUB publications by mistake; the web service includes the following security conditions:
- It is not possible to call the web service without query parameters . It is still possible to delete all the publications from the KHUB by adding the following parameter: .../api/admin/khub/publications?ft:isPublication=true
- It is not possible to use a metadata element which does not exist in the KHUB. In this case, the web service returns the list of available metadata.
If one of these conditions is not followed, the server returns a 400 error code.