Get publications by metadata - Fluid Topics - Latest

Fluid Topics API Reference Guide
Category
Reference Guides
Audience
public
Version
Latest

This web service returns all structured and unstructured documents matching selected metadata.

Method Endpoint
GET /api/admin/khub/publications?metadata1=value1&...&metadataN=valueN
Query string parameter Type Required? Description
metadata=value String Yes Any metadata key-value couple that differentiates the publication. Use as much metadata as necessary to define unique content.

Request example

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

This web service can be used before calling the Delete publications by metadata web service.

  • It is not possible to get the topics associated with selected metadata using this web service.
  • If no metadata are defined, all publications are returned.

This web service returns a maximum count of 1000 publications.

Response body

{
  "counts": 1,
  "items": [
    {
      "id": "AiB9GGMyDHSgeVFOxYJ_SQ",
      "title": "Publication title",
      "metadata": [
        {
          "key": "metadata1",
          "label": "My metadata",
          "values": [
            "value1"
          ]
        },
        {
          "key": "metadata2",
          "label": "My second metadata",
          "values": [
            "value2"
          ]
        }
      ]
    }
  ]
}
Field Type Description
counts Number Number of Knowledge Hub publications (items) corresponding to the given query.
items Array List of publications corresponding to the query.
id String Identifier of the publication.
title String Title of the publication.
metadata Array An array containing the key, values, and label fields. If any of the metadata's values are organized in hierarchical order, the hierarchical values field is present instead of the values field.
key String The metadata facet's ID.
label String The publication's metadata as displayed in Fluid Topics.
values Array The publication's metadata values for a given metadata element.

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 as in the following 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, ...}"
}