Update/Replace Metadata of Maps and UDs - Fluid Topics - 3.6

Use Fluid Topics Web API

Product
Fluid Topics
FT_Version
3.6
Category
Technical Notes
language
English

As the documentation evolves, it may be necessary to modify the metadata associated with a publication.

It is not possible to update metadata associated with a topic using this web service.

This web service updates the metadata of the concerned publications.

Method

Endpoint

PUT

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

Where metadata=value is any metadata key-value couple that differentiates the publication to be updated.

Content reprocessing is not required. Changes will be overridden if the document is reuploaded.

To update the metadata, it is necessary to add a JSON input.

Input Example

{
"metadata":
[
{
"key": "Supported_OS",
"value": "Google Chrome"
},
{
"key": "khubApiVersion",
"values": [
"3.6.2",
"3.6.3"
]
}
],
"mode": "update|replace"
}

Where:

  • "metadata" is the list of the metadata key-value couple to update.
  • "key" is the metadata facet ID to update.
  • "value" or "values" is the publications metadata value(s) to update.
  • "mode" is the web service mode. It takes one of the following values:
    • update: the former metadata are kept and updated following the metadata newly defined.
    • replace: ALL the former metadata are deleted and replaced by the metadata newly defined.

Any customer metadata can be updated or replaced with this web service. The following built-in metadata only can also be modified: ft:title, ft:locale, ft:openMode, ft:originUrl, ft:clusterId, ft:lastEdition, ft:editorialType, and ft:description.

Return codes

Return Code

Description

202 ACCEPTED

The update instruction was sent to the Fluid Topics processing pipeline.

400 BAD REQUEST

Invalid query.

500 INTERNAL SERVER ERROR

The Fluid Topics Server failed to respond.