List vocabularies - Fluid Topics - Latest

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

This web service returns a list of the vocabularies configured for a tenant.

Method Endpoint
GET /api/admin/khub/vocabularies

Response body

[
  {
    "id": "vocabulary1",
    "usedInSearch": false,
    "description": "generated from Knowledge Hub user interface",
    "locales": [
      "en-US"
    ],
    "mimeType": "application/rdf+xml",
    "lastUpdate": {
      "user": "Root User",
      "date": "2022-09-02T13:25:57Z"
    },
    "mode": "FULL"
  },
  {
    "id": "vocabulary2",
    "usedInSearch": true,
    "description": "generated from Knowledge Hub user interface",
    "locales": [
      "en-US",
      "fr-FR"
    ],
    "mimeType": "application/rdf+xml",
    "lastUpdate": {
      "user": "Root User",
      "date": "2022-09-02T09:36:11Z"
    },
    "mode": "FULL"
  }
]
Field Type Description
id String The vocabulary's unique identifier.
usedInSearch Boolean Defines whether the search engines uses the vocabulary when indexing content.
description String Deprecated. The description of the vocabulary as it appears in the Back Office.
locales Array The languages in which the vocabulary is available.
mimeType String Defines the format of the file containing the terms of the vocabulary. Possible values are text/csv and application/rdf+xml.
lastUpdate Object Defines whether the vocabulary has been updated, when, and by whom.
mode String Deprecated. The mode of the vocabulary as it appears in the Back Office. Possible values are FULL for taxonomies and LIST for synonyms.
Return code Description
200 OK The request is valid and data was returned.
401 UNAUTHORIZED The authorization header was not provided or is invalid.
403 FORBIDDEN The user not have the ADMIN or KHUB_ADMIN role.

For a list of all possible return codes, see Return codes.