List Maps - Fluid Topics - 3.3 - Reference Guides

Fluid Topics API Reference Guide

Product
Fluid Topics
Fluid Topics Version
3.3
Category
Reference Guides
Language
English
Target Audience
public

It is recommended to use pagination when crawling maps.

This web service returns the list of Fluid Topics maps.

Method

Endpoint

GET

/api/khub/maps

Input Example

{
"page": "3",
"per_page": "99"
}

Where:

  • "page" is the page number. This optional query parameter starts at 1 and defaults to 1.
  • "per_page" is the number of results per page. This optional query parameter defaults at -1, meaning that all results are returned.

Output Example

[
{
"title": "AFS Integration Guide",
"id": "fbbhN_AWAcYrc0DjH5L1hQ",
"mapApiEndpoint": "/api/khub/maps/fbbhN_AWAcYrc0DjH5L1hQ",
"metadata": [
{
"key": "Category",
"label": "Category",
"values": [
"Reference Guide"
]
},
{
"key": "Product",
"label": "Product",
"values": [
"AFS"
]
},
{
"key": "AFS_Version",
"label": "AFS_Version",
"values": [
"7.8"
]
}
]
},
{
"title": "AFS Integration Guide",
"id": "Z_FG1_XV6hD3Iz3jKGbMfw",
"mapApiEndpoint": "/api/khub/maps/Z_FG1_XV6hD3Iz3jKGbMfw",
"metadata": [
{
"key": "Category",
"label": "Category",
"values": [
"Reference Guide"
]
},
{
"key": "Product",
"label": "Product",
"values": [
"AFS"
]
},
{
"key": "AFS_Version",
"label": "AFS_Version",
"values": [
"7.7"
]
}
]
}
]

Where:

  • "title" is the title of the map:publication.
  • "id" is the unique identifier of the map necessary to retrieve its structure.
  • "mapApiEndpoint" is the path where details about a map can be found.
  • "metadata" are all the key (facet) and value (facet value) metadata of the map.

In this example, Fluid Topics contains two maps, one for AFS Version 7.7, and one for 7.8.