API quick reference - Fluid Topics - Latest

Knowledge Hub web services for everyone

Method	Endpoint	Title
GET	/api/khub/maps	List maps
GET	/api/khub/maps/{mapId}	Get a map
GET	/api/khub/maps/{mapId}/rights	Get a map's access rights
GET	/api/khub/maps/{mapId}/toc	Get a map's table of contents
POST	/api/khub/maps/search	Search maps
GET	/api/khub/maps/{mapId}/attachments	List map attachments
GET	/api/khub/maps/{mapId}/attachments/{khubId}/content	Download a map attachment
GET	/api/khub/maps/{mapId}/resources	List a map's resources
GET	/api/khub/maps/{mapId}/resources/{resourceId}	Get the metadata of a map's resource
GET	/api/khub/maps/{mapId}/resources/{resourceId}/content	Get the content of a map's resource
GET	/api/khub/maps/{mapId}/rating	Get a map's rating
POST	/api/khub/maps/{mapId}/rating	Rate a map
DELETE	/api/khub/maps/{mapId}/rating	Delete a map's rating
POST	/api/khub/maps/{mapId}/feedback	Send feedback about a map
GET	/api/khub/maps/{mapId}/topics	List a map's topics
GET	/api/khub/maps/{mapId}/topics/{contentId}	Get a topic
GET	/api/khub/maps/{mapId}/topics/{contentId}/content	Get a topic's content
POST	/api/khub/maps/{mapId}/topics/{tocId}/rating	Rate a topic
DELETE	/api/khub/maps/{mapId}/topics/{tocId}/rating	Delete a topic's rating
POST	/api/khub/maps/{mapId}/topics/{tocId}/feedback	Send feedback about one of a map's topics
GET	/api/khub/topic/styled-content?$FILTER_1=value_1&...&$FILTER_N=value_n	Get a topic's styled content
POST	/api/khub/topics/search	Search topics
GET	/api/khub/section/html?${CONTEXT_ID}=1234&${FILTER_1}=value_1&...&${FILTER_N}=value_n	Get the content of an HTML section
GET	/api/khub/documents	List documents
GET	/api/khub/documents/{docId}	Get a document's metadata
GET	/api/khub/documents/{docId}/content	Get the content of a document
GET	/api/khub/documents/{docId}/content/text	Get the content of a document as plain text
GET	/api/khub/documents/{docId}/rights	Get a document's access rights
POST	/api/khub/documents/search	Search documents
GET	/api/khub/documents/{docId}/rating	Get a document's rating
POST	/api/khub/documents/{docId}/rating	Rate a document
DELETE	/api/khub/documents/{docId}/rating	Delete a document's rating
POST	/api/khub/maps/{docId}/feedback	Send feedback about a document
GET	/api/khub/locales	Get locales for all content
POST	/api/khub/locales/search	Get locales for filtered content
POST	/api/khub/clustered-search	Clustered search
POST	/api/khub/suggest	Suggest

Knowledge Hub web services for administrators

Method	Endpoint	Title
GET	/api/admin/khub/dataflow/reports	List dataflow reports
GET	/api/admin/khub/dataflow/reports/{reportId}	Get a dataflow report
GET	/api/khub/uploads/{uploadId}/report	Get a publish report
PUT	/api/admin/khub/dataflow/reprocess	Reprocess content
PUT	/api/admin/khub/dataflow/reindex	Reindex content
GET	/api/admin/khub/sources	List sources
GET	/api/admin/khub/sources/{sourceId}	Get a source
PUT	/api/admin/khub/sources/{sourceId}	Create a source
DELETE	/api/admin/khub/sources/{sourceId}	Delete a source
POST	/api/admin/khub/sources/{sourceId}/upload?publisher=username	Upload content
DELETE	/api/admin/khub/maps/{mapId}	Delete a map
PUT	/api/admin/khub/maps/attachments?metadata1=value1&...&metadataN=valueN	Add or update map attachments
DELETE	/api/admin/khub/maps/attachments?metadata1=value1&...&metadataN=valueN	Delete a map attachment by originId
DELETE	/api/admin/khub/maps/attachments?metadata1=value1&...&metadataN=valueN	Delete a map attachment by khubId
DELETE	/api/admin/khub/documents/{docId}	Delete an unstructured document
GET	/api/admin/khub/publications?metadata1=value1&...&metadataN=valueN	Get publications by metadata
PUT	/api/admin/khub/publications/update-metadata?metadata1=value1&...&metadataN=valueN	Update/replace publication metadata
DELETE	/api/admin/khub/publications?metadata1=value1&...&metadataN=valueN	Delete publications by metadata
GET	/api/admin/khub/vocabularies	List vocabularies
POST	/api/admin/khub/vocabularies	Create a vocabulary
PUT	/api/admin/khub/vocabularies/{vocabularyId}	Update a vocabulary's configuration
PUT	/api/admin/khub/vocabularies/{vocabularyId}/content	Update a vocabulary's content and structure
GET	/api/admin/khub/vocabularies/{vocabularyId}/content?format=$VOCABULARY_MIMETYPE	Download a vocabulary
DELETE	/api/admin/khub/vocabularies/{vocabularyId}	Delete a vocabulary
PUT	/api/admin/khub/dita-ot	Upload DITA-OT
GET	/api/admin/khub/dita-ot	Get DITA-OT metadata
GET	/api/admin/khub/dita-ot/content	Download DITA-OT
GET	/api/khub/packages	List content packages
GET	/api/khub/packages/{packageId}	Get a content package's metadata
DELETE	/api/khub/packages/{packageId}	Delete a content package
POST	/api/khub/packages	Create a content package
GET	/api/khub/packages/{packageId}/result.zip	Download a content package archive

Users

Method	Endpoint	Title
GET	/api/users	List all users
POST	/api/users/search	Search users
GET	/api/users/{userId}	Get a user
GET	/api/users/{userId}/dump	Get a user's personal information and assets
POST	/api/users/register	Create a user
PUT	/api/users/{userId}	Change a user's display name
PUT	/api/users/{userId}/password	Change a user's password
DELETE	/api/users/{userId}	Delete a user
GET	/api/users/{userId}/groups	Get a user's groups
PUT	/api/users/{userId}/groups	Set a user's groups
GET	/api/users/{userId}/roles	Get a user's roles
PUT	/api/users/{userId}/roles	Set a user's roles
GET	/api/users/{userId}/bookmarks	List bookmarks
DELETE	/api/users/{userId}/bookmarks	Delete all bookmarks
POST	/api/users/{userId}/bookmarks	Create a bookmark
PUT	/api/users/{userId}/bookmarks/{bookmarkId}	Update a bookmark
DELETE	/api/users/{userId}/bookmarks/{bookmarkId}	Delete a bookmark
GET	/api/users/{userId}/searches	List searches
DELETE	/api/users/{userId}/searches	Delete all searches
POST	/api/users/{userId}/searches	Create a search
PUT	/api/users/{userId}/searches/{searchId}	Update a search
DELETE	/api/users/{userId}/searches/{searchId}	Delete a search
GET	/api/users/{userId}/collections	List collections
DELETE	/api/users/{userId}/collections	Delete all collections
POST	/api/users/{userId}/collections	Create a static collection
POST	/api/users/{userId}/collections	Create a swift collection
PUT	/api/users/{userId}/collections/{collectionId}	Update a static collection
PUT	/api/users/{userId}/collections/{collectionId}	Update a swift collection
DELETE	/api/users/{userId}/collections/{collectionId}	Delete a collection
GET	/api/users/{userId}/collections/{collectionId}/documents	List a collection's documents
POST	/api/users/{userId}/personal-books	Create a personal book

Authentication

Method	Endpoint	Title
POST	/api/authentication/login	Sign in with credentials
GET	/api/authentication/current-session	Get session information
POST	/api/authentication/logout	Log out of a Fluid Topics portal
GET	api/authentication/sso/{realmId}/login?urlAfterLogin=https://...	Authentication with SSO

Languages

Method	Endpoint	Title
GET	/api/locales/default	Get default locale configuration
POST	/api/locales/default	Update default locale configuration

Tenants

Method	Endpoint	Title
GET	/api/tenants	List tenants
GET	/api/tenants/{tenantId}	Get a tenant
GET	/api/health?components=search,contentRepository,mongoDb	Get a tenant health report
GET	/api/probe	Get a front server health report

Analytics

Method	Endpoint	Title
POST	/analytics/api/v2/khub/views-heatmap	Content usage heatmap
POST	/analytics/api/v1/khub/time-report	Content inventory
POST	/analytics/api/v2/documents/views-top	Document views
POST	/analytics/api/v2/documents/{id}/topics/views-heatmap	Document heatmap
POST	/analytics/api/v1/topics/views-top	Topic views
POST	/analytics/api/v1/documents/ratings	Document ratings
POST	/analytics/api/v1/topics/ratings	Topic ratings
POST	/analytics/api/v1/traffic/user-activity	User activity
POST	/analytics/api/v1/users/assets/time-report	User assets
POST	/analytics/api/v1/traffic/event-counts	Events count
POST	/analytics/api/v2/traffic/sessions	Sessions
POST	/analytics/api/v1/traffic/page-views	Page views
POST	/analytics/api/v1/traffic/api-calls-heatmap	API calls heatmap v1
POST	/analytics/api/v2/traffic/api-calls-heatmap	API calls heatmap v2
POST	/analytics/api/v1/traffic/api-calls	API calls v1
POST	/analytics/api/v2/traffic/api-calls	API calls v2
GET	/analytics/api/calling-apps	Calling apps v1
GET	/analytics/api/v2/traffic/inventory/calling-apps	Calling apps v2
POST	/analytics/api/v2/traffic/browsers-top	Traffic by browser
POST	/analytics/api/v2/traffic/countries-top	Traffic by country
GET	/analytics/api/v1/traffic/inventory/pages	Pages
POST	/analytics/api/v2/searches/facets-heatmap	Most popular facets
POST	/analytics/api/v2/searches/terms-top	Search terms
POST	/analytics/api/v2/searches/no-results-top	Searches with no results
POST	/analytics/api/v1/events	Retrieve events

Generative AI

Method	Endpoint	Title
POST	/api/ai/generate	Query a large language model (LLM)