Get 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 returns all the publications (Maps and Unstructured Documents) based on selected metadata.

It is not possible to get the topics associated with selected metadata using this web service.

If no metadata is given, all the publications are returned.

As an example, this web service can be used as a dry run before calling the Delete Maps and UDs by Metadata web service.

Method

Endpoint

GET

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

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

Example: https://myportal.fluidtopics.net/api/admin/khub/publications?version=3.6&Category=Technical%20Notes

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.

Example:

https://myportal.fluidtopics.net/api/admin/khub/publications?versoinn=3.7

HTTP/1.1 400 Bad Request
{
"errorMessage": "Invalid filters: {versoinn}, use filter among: {
audience, category, dataset, dita:ditaval, ft:baseId, ft:description, ft:document_type, (...), ft:structure, ft:title, prodname, version, ...}"
}

Output Example

{
"counts": 1,
"items": [
{
"id": "AiB9GGMyDHSgeVFOxYJ_SQ",
"title": "Document title",
"metadata": [
{
"key": "metadata1",
"label": "My metadata",
"values": [
"value1"
]
},
{
"key": "metadata2",
"label": "My second metadata",
"values": [
"value2"
]
}
]
}
]
}

The output provides the following parameters:

Parameter

Description

counts

Number of Knowledge Hub publications (items) corresponding to the given query.

items

List of publications corresponding to the query.

id

Identifier of the publication.

title

Title of the publication.

metadata

Contains all information in relation with the publication metadata.

key

The metadata facet ID.

label

The publication metadata as displayed in Fluid Topics.

values

The publication metadata values for a given metadata element.