This web service lists the maps available in a portal's Knowledge Hub.
| Method | Endpoint |
|---|---|
GET |
/api/khub/maps |
Information
- For analytics purposes, users should define a user agent in the headers when listing maps on a Fluid Topics portal.
- It is possible to use pagination with this web service.
- Using pagination when listing maps is recommended.
Response body
The following lines show an example of a JSON response body containing two maps, one for AFS Version 7.7 and one for 7.8.
[
{
"title": "AFS Integration Guide",
"id": "fbbhN_AWAcYrc0DjH5L1hQ",
"mapApiEndpoint": "/api/khub/maps/fbbhN_AWAcYrc0DjH5L1hQ",
"metadata": [
{
"key": "author",
"label": "Author",
"values": [
"Alan Smithee"
],
},
{
"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"
]
}
]
}
]
| Field | Type | Description |
|---|---|---|
title |
String | The map's title. |
id |
String | The map's unique identifier. |
mapApiEndpoint |
String | The path where details about a map can be found. |
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. |
In this example, Fluid Topics contains two maps, one for AFS Version 7.7, and one for 7.8.